v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB

Automations

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

Path parameters

automationIdstring required

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

Example:auto_abc

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

Headers

Idempotency-Keystring

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

Request body

payloadobject

testRecipientstring email

Response

Test run started.

triggerInstanceIdstring

automationRunIdsstring[] required

status'triggered' | 'idempotent_replay' | 'test_started' | 'replay_started' required

receivedAtstring date-time required

warningsstring[]