Test an automation

Runs the saved automation END-TO-END through the real workflow in TEST mode — works on drafts and for both event and manual-audience automations; every node executes (filters/splits evaluate against payload, wait nodes fast-forward). Pass testRecipient to DELIVER each send-email node’s email for real to that address (real subject/preview/sender name via the Brew test domain; customer addresses are never hit) — omit it for a silent dry-run with no mail. Test runs never count against analytics rollups or send quotas. Returns 202 with the started run id; follow per-node status via GET /v1/automations/runs?automationRunId=&include=logs.

POST /v1/automations/{automationId}/test

Test an automation

cURL

curl --request POST \
  --url https://brew.new/api/v1/automations/{automationId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "email": "[e-mail]",
    "plan": "pro"
  },
  "testRecipient": "[e-mail]"
}
'

202

{
  "automationRunIds": [
    "run_01HZ"
  ],
  "status": "test_started",
  "receivedAt": "2026-04-08T12:34:56.789Z"
}

Authorizations

bearerAuthapiKeyAuth

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

Path Parameters

automationId · string · required

Automation id returned by POST /v1/automations and listed by GET /v1/automations.

Required string length: 1 - 64

Example:

"auto_abc"

Body

application/json

payload · object

Show child attributes

testRecipient · string<email>

Response

202

application/json

Test run started.

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

Show child attributes

warnings · string[]