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"
}
'

{
  "success": true,
  "code": "<string>",
  "message": "<string>",
  "receivedAt": "<string>",
  "triggerEventId": "<string>",
  "details": {
    "resolvedPayload": {},
    "warnings": [
      "<unknown>"
    ],
    "idempotencyKey": "<string>",
    "triggerInstanceId": "<string>",
    "publishedTransactionalEmails": [
      {
        "emailId": "<string>"
      }
    ],
    "publishedAutomations": [
      {
        "automationId": "<string>",
        "title": "<string>"
      }
    ],
    "automationRunIds": [
      "<string>"
    ],
    "counts": {
      "transactionalEmails": 123,
      "automations": 123
    }
  }
}

Automation Runs

Fire test or replay an automation run

POST body is a 3-branch union, dispatched by body shape:

Fire — { triggerEventId, payload, idempotencyKey? }. Starts one Vercel Workflow per published automation attached to the trigger and returns the FIRE_EVENT_RESPONSE envelope { success, status: "triggered" | "idempotent_replay", code, message, receivedAt, details: { automationRunIds[], triggerInstanceId, counts, … } }. Read details.automationRunIds.
Test — { automationId, mode: "test", payload? }. Suppression-aware test run; no real mail sent. Returns the flat { automationRunIds[], status: "test_started", … } shape (top-level automationRunIds).
Replay — { automationRunId, mode: "replay" }. Re-runs a prior run with the same payload + mode against the automation’s current saved draft. Returns EXECUTIONS_POST_RESPONSE with status: "replay_started" + the new automationRunIds.

Supports Idempotency-Key header on the fire branch — retries with the same key return the original automationRunIds without starting duplicate workflow runs.

POST

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"
}
'

{
  "success": true,
  "code": "<string>",
  "message": "<string>",
  "receivedAt": "<string>",
  "triggerEventId": "<string>",
  "details": {
    "resolvedPayload": {},
    "warnings": [
      "<unknown>"
    ],
    "idempotencyKey": "<string>",
    "triggerInstanceId": "<string>",
    "publishedTransactionalEmails": [
      {
        "emailId": "<string>"
      }
    ],
    "publishedAutomations": [
      {
        "automationId": "<string>",
        "title": "<string>"
      }
    ],
    "automationRunIds": [
      "<string>"
    ],
    "counts": {
      "transactionalEmails": 123,
      "automations": 123
    }
  }
}

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

Option 1
Option 2
Option 3

triggerEventId

string

required

Required string length: 1 - 256

payload

object

required

Show child attributes

idempotencyKey

string

Required string length: 1 - 100

Response

Idempotent replay — original automationRunIds returned.

Option 1
Option 2

success

boolean

required

status

enum<string>

required

Discriminator for the response category. Pairs with code. A trigger with no published automation attached returns status: "failed" + code: "NO_PUBLISHED_AUTOMATION" (HTTP 422). Successful fires always return status: "triggered".

Available options:

triggered,

idempotent_replay,

ready,

invalid_api_key,

invalid_json,

failed,

forbidden,

payload_mismatch,

trigger_event_not_found

code

string

required

message

string

required

receivedAt

string

required

ISO-8601 timestamp the request was processed at.

triggerEventId

string

details

object

Show child attributes

List recent automation runs (filterable) OR get one Cancel an in-flight automation run (not implemented yet)

⌘I