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": [
"run_01HZ"
],
"status": "test_started",
"receivedAt": "2026-04-08T12:34:56.789Z"
}{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "payload"
}
}{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "automations"
}
}{
"error": {
"code": "AUTOMATION_NOT_FOUND",
"type": "not_found",
"message": "Automation 'auto_xxx' was not found.",
"suggestion": "List automations with GET /v1/automations.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "automationId"
}
}{
"error": {
"code": "IDEMPOTENCY_CONFLICT",
"type": "conflict",
"message": "The same idempotency key was reused with a different request payload.",
"suggestion": "Reuse the original payload or send a new idempotency key.",
"docs": "https://docs.brew.new/api-reference/api/idempotency"
}
}{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}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.
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": [
"run_01HZ"
],
"status": "test_started",
"receivedAt": "2026-04-08T12:34:56.789Z"
}{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "payload"
}
}{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "automations"
}
}{
"error": {
"code": "AUTOMATION_NOT_FOUND",
"type": "not_found",
"message": "Automation 'auto_xxx' was not found.",
"suggestion": "List automations with GET /v1/automations.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "automationId"
}
}{
"error": {
"code": "IDEMPOTENCY_CONFLICT",
"type": "conflict",
"message": "The same idempotency key was reused with a different request payload.",
"suggestion": "Reuse the original payload or send a new idempotency key.",
"docs": "https://docs.brew.new/api-reference/api/idempotency"
}
}{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.
1 - 100Path Parameters
Automation id returned by POST /v1/automations and listed by GET /v1/automations.
1 - 64"auto_abc"
Response
Test run started.
1 - 64triggered, idempotent_replay, test_started, replay_started 4 - 64Show child attributes
Show child attributes
Was this page helpful?