Skip to main content
POST
/
automations
/
{automationId}
/
trigger
curl --request POST \
  --url https://brew.new/api/automations/{automationId}/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "email": "customer@example.com",
    "firstName": "John",
    "orderId": "ORD-12345",
    "orderTotal": 99.99
  }
}
'
{
  "success": true,
  "executionId": "<string>",
  "automationId": "<string>",
  "eventId": "<string>",
  "status": "running",
  "contact": {
    "email": "<string>",
    "action": "created",
    "warning": {
      "status": "<string>",
      "reason": "<string>"
    }
  },
  "warning": {
    "code": "CONTACT_SEND_BLOCKED",
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer brew_xxxxx header

Path Parameters

​
automationId
string
required

The event ID or automation ID. Accepts two formats:

  • Event ID: User-defined string (e.g., lead_generated, user_signup)
  • Automation ID: Internal document ID (alphanumeric, no underscores)

Body

application/json
​
payload
object
required

The event payload. Must conform to the automation's configured schema.

Important: The email field is ALWAYS required at the root level. Brew uses this email to automatically look up or create a contact.

Keep payloads flat and minimal - avoid nested objects when possible. Typical fields: email, firstName, orderId, etc.

​
metadata
object

Optional metadata to attach to the execution. This data is not validated against the schema and is stored for reference only.

Response

Automation triggered successfully

​
success
enum<boolean>
required
Available options:
true
​
executionId
string

Unique identifier for this automation execution

​
automationId
string

The automation that was triggered

​
eventId
string

The event ID configured for this automation

​
status
enum<string>

Initial status of the execution

Available options:
running
​
contact
object

Contact upsert result - contacts are automatically created or updated based on the email in the payload

​
warning
object

Present if the email delivery will be blocked