Skip to main content
POST
/
v1
/
automations
/
{automationId}
/
test
Test an automation
curl --request POST \
  --url https://brew.new/api/v1/automations/{automationId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "email": "qa@example.com"
  }
}
'
{
  "automationRunIds": [
    "run_01HZ"
  ],
  "status": "test_started",
  "receivedAt": "2026-04-08T12:34:56.789Z"
}

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

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

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