Skip to main content
POST
Test an automation

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
X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

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
testRecipient
string<email>

Response

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
warnings
string[]