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",
    "plan": "pro"
  },
  "testRecipient": "qa@example.com"
}
'

import requests

url = "https://brew.new/api/v1/automations/{automationId}/test"

payload = {
    "payload": {
        "email": "qa@example.com",
        "plan": "pro"
    },
    "testRecipient": "qa@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payload: {email: 'qa@example.com', plan: 'pro'},
    testRecipient: 'qa@example.com'
  })
};

fetch('https://brew.new/api/v1/automations/{automationId}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/automations/{automationId}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payload' => [
        'email' => 'qa@example.com',
        'plan' => 'pro'
    ],
    'testRecipient' => 'qa@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/automations/{automationId}/test"

	payload := strings.NewReader("{\n  \"payload\": {\n    \"email\": \"qa@example.com\",\n    \"plan\": \"pro\"\n  },\n  \"testRecipient\": \"qa@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/automations/{automationId}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payload\": {\n    \"email\": \"qa@example.com\",\n    \"plan\": \"pro\"\n  },\n  \"testRecipient\": \"qa@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/automations/{automationId}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payload\": {\n    \"email\": \"qa@example.com\",\n    \"plan\": \"pro\"\n  },\n  \"testRecipient\": \"qa@example.com\"\n}"

response = http.request(request)
puts response.read_body

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

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, and contact.<name> conditions read the test recipient’s contact unless payload supplies that field — a flat contact.<name> key or a contact object — and the trigger’s contract keeps extra keys; 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. Optional scenario controls simulate timed opens/clicks at engagement-filter nodes and force left/right percentage-split choices (waits use a virtual clock; controls stay separate from payload, and simulated events never enter live analytics or send quotas); the run row’s testCoverage reports visited nodes, traversed connections, evaluated or forced decisions, uncovered paths and simulation limitations.

POST

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",
    "plan": "pro"
  },
  "testRecipient": "qa@example.com"
}
'

import requests

url = "https://brew.new/api/v1/automations/{automationId}/test"

payload = {
    "payload": {
        "email": "qa@example.com",
        "plan": "pro"
    },
    "testRecipient": "qa@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payload: {email: 'qa@example.com', plan: 'pro'},
    testRecipient: 'qa@example.com'
  })
};

fetch('https://brew.new/api/v1/automations/{automationId}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://brew.new/api/v1/automations/{automationId}/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payload' => [
        'email' => 'qa@example.com',
        'plan' => 'pro'
    ],
    'testRecipient' => 'qa@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://brew.new/api/v1/automations/{automationId}/test"

	payload := strings.NewReader("{\n  \"payload\": {\n    \"email\": \"qa@example.com\",\n    \"plan\": \"pro\"\n  },\n  \"testRecipient\": \"qa@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/automations/{automationId}/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payload\": {\n    \"email\": \"qa@example.com\",\n    \"plan\": \"pro\"\n  },\n  \"testRecipient\": \"qa@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/automations/{automationId}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payload\": {\n    \"email\": \"qa@example.com\",\n    \"plan\": \"pro\"\n  },\n  \"testRecipient\": \"qa@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "automationRunIds": [
    "jh7acthhe99pq4448xh83gn54x8eennb"
  ],
  "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

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:

"M3nRk8LqW2xT5vBp9YcZd"

Body

application/json

payload

object

Show child attributes

testRecipient

string

Maximum string length: 254

Pattern:

^[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+$

scenario

object

Simulated engagement and forced split branches for this test run; omit for a plain dry run in which engagement filters take their else branch.

Show child attributes

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

testMode

enum<string>

Available options:

smoke,

scenario

counts

object

Show child attributes

warnings

object[]

Show child attributes

Overview

Core concepts

Guides

MCP server

CLI

Public API v1

Test an automation

Authorizations

Headers

Path Parameters

Body

Response