Skip to main content
POST
/
events
/
send
curl --request POST \
  --url https://api.brew.new/v1/events/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "eventName": "userSignup",
  "firstName": "Alex",
  "lastName": "Johnson",
  "eventProperties": {
    "signupSource": "landing_page_a",
    "planSelected": "free"
  },
  "subscriptionGroups": {
    "sg_newsletter": true,
    "sg_product_updates": false
  }
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Include your Brew API key as a Bearer token in the Authorization header. Example: Authorization: Bearer bw_api_your_key_here

Headers

​
Idempotency-Key
string

Unique identifier to prevent duplicate events. Especially important for purchase events or other critical actions where duplicates could cause issues.

Maximum string length: 100

Body

application/json

Provide the contact's email, event details, and optionally contact information to update. Event properties become available as variables in triggered emails.

  • Contact Matching: You can provide email, userId, or both to identify the contact. When both are provided, Brew searches for a contact matching either identifier. If a contact is found (for example, by email), the other identifier (userId) will be updated on that contact. If no existing contact matches either identifier, a new contact is created with both values.
  • Custom Contact Properties: Include any custom contact properties as top-level fields. Custom properties can be strings, numbers, booleans, or dates. You must create custom properties in Brew before using them in API calls. For detailed information about creating and managing custom properties, see our Custom Properties guide in the Audience section.

JSON request body fields for sending an event

​
email
string<email>
required

Email address of the contact to associate with this event

Example:

"[email protected]"

​
eventName
string
required

Name of the event (used to trigger automations)

Example:

"purchaseComplete"

​
firstName
string

Contact's first name (will update contact if they exist, or set when creating new contact)

Example:

"Alex"

​
lastName
string

Contact's last name (will update contact if they exist, or set when creating new contact)

Example:

"Johnson"

​
userId
string

Unique external user ID (e.g., from your app or CRM)

Example:

"user_12345"

​
source
string

Custom source value to track where the contact came from (defaults to "API")

Example:

"Website signup"

​
subscribed
boolean
default:true

Whether the contact is subscribed to marketing emails

​
eventProperties
object

Additional data about the event (available as variables in triggered emails)

Example:
{
  "orderTotal": 149.99,
  "productName": "Pro Plan",
  "isFirstPurchase": true
}
​
subscriptionGroups
object

Subscription groups to add the contact to

Example:
{ "sg_customers": true }

Response

Event sent successfully and will trigger any matching automations

Success response for event sending

​
success
boolean
required

Indicates the event was processed successfully

Example:

true