Skip to main content
POST
/
v1
/
automation
/
runs
curl --request POST \
  --url https://brew.new/api/v1/automation/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "triggerEventId": "tri_password_reset",
  "payload": {
    "email": "jane@example.com",
    "resetUrl": "https://app.example.com/reset/abc"
  },
  "idempotencyKey": "reset-jane-2026-04-08"
}
'
{
  "automationRunIds": [
    "<string>"
  ],
  "receivedAt": "2023-11-07T05:31:56Z",
  "triggerInstanceId": "<string>",
  "counts": {
    "automations": 1,
    "transactionalEmails": 1
  },
  "warnings": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.brew.new/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

​
Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100

Body

application/json
​
triggerEventId
string
required
Required string length: 1 - 256
​
payload
object
required
​
idempotencyKey
string
Required string length: 1 - 100
​
dryRun
boolean

Response

Idempotent replay — original automationRunIds returned.

​
automationRunIds
string[]
required
Required string length: 1 - 64
​
status
enum<string>
required
Available options:
triggered,
idempotent_replay,
test_started,
replay_started
​
receivedAt
string<date-time>
required
​
triggerInstanceId
string
Required string length: 4 - 64
​
counts
object
​
warnings
string[]