Create a trigger
curl --request POST \
--url https://brew.new/api/v1/automations/triggers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "User Signed Up",
"description": "Fires when a user completes signup.",
"payloadSchema": {
"type": "object",
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "firstName",
"type": "string",
"required": false
}
]
}
}
'import requests
url = "https://brew.new/api/v1/automations/triggers"
payload = {
"title": "User Signed Up",
"description": "Fires when a user completes signup.",
"payloadSchema": {
"type": "object",
"fields": [
{
"key": "email",
"type": "string",
"required": True
},
{
"key": "firstName",
"type": "string",
"required": False
}
]
}
}
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({
title: 'User Signed Up',
description: 'Fires when a user completes signup.',
payloadSchema: {
type: 'object',
fields: [
{key: 'email', type: 'string', required: true},
{key: 'firstName', type: 'string', required: false}
]
}
})
};
fetch('https://brew.new/api/v1/automations/triggers', 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/triggers",
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([
'title' => 'User Signed Up',
'description' => 'Fires when a user completes signup.',
'payloadSchema' => [
'type' => 'object',
'fields' => [
[
'key' => 'email',
'type' => 'string',
'required' => true
],
[
'key' => 'firstName',
'type' => 'string',
'required' => false
]
]
]
]),
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/triggers"
payload := strings.NewReader("{\n \"title\": \"User Signed Up\",\n \"description\": \"Fires when a user completes signup.\",\n \"payloadSchema\": {\n \"type\": \"object\",\n \"fields\": [\n {\n \"key\": \"email\",\n \"type\": \"string\",\n \"required\": true\n },\n {\n \"key\": \"firstName\",\n \"type\": \"string\",\n \"required\": false\n }\n ]\n }\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/triggers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"User Signed Up\",\n \"description\": \"Fires when a user completes signup.\",\n \"payloadSchema\": {\n \"type\": \"object\",\n \"fields\": [\n {\n \"key\": \"email\",\n \"type\": \"string\",\n \"required\": true\n },\n {\n \"key\": \"firstName\",\n \"type\": \"string\",\n \"required\": false\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/automations/triggers")
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 \"title\": \"User Signed Up\",\n \"description\": \"Fires when a user completes signup.\",\n \"payloadSchema\": {\n \"type\": \"object\",\n \"fields\": [\n {\n \"key\": \"email\",\n \"type\": \"string\",\n \"required\": true\n },\n {\n \"key\": \"firstName\",\n \"type\": \"string\",\n \"required\": false\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"triggerEventId": "tri_signup",
"title": "User Signed Up",
"description": "Fires when a user completes signup.",
"provider": "brew_api",
"payloadSchema": {
"type": "object",
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "firstName",
"type": "string",
"required": false
}
]
},
"createdAt": "2026-04-08T12:00:00.000Z",
"updatedAt": "2026-04-08T12:00:00.000Z"
}{
"error": {
"code": "PAYLOAD_SCHEMA_EMAIL_REQUIRED",
"type": "invalid_request",
"message": "payloadSchema.fields must declare { key: \"email\", type: \"string\", required: true }.",
"suggestion": "Add the required email field to payloadSchema.fields.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "payloadSchema"
}
}{
"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": "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"
}
}Automations
Create a trigger
Creates a custom trigger event definition, the contract automations subscribe to. Body carries { title, description?, payloadSchema }; the server mints triggerEventId and hardcodes provider: "brew_api". Integration triggers (clerk, stripe, shopify, …) are provisioned by the corresponding integration only.
payloadSchema.fields MUST declare { key: "email", type: "string", required: true } so downstream automations can resolve a recipient. Returns 201 with the bare trigger row.
POST
/
v1
/
automations
/
triggers
Create a trigger
curl --request POST \
--url https://brew.new/api/v1/automations/triggers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "User Signed Up",
"description": "Fires when a user completes signup.",
"payloadSchema": {
"type": "object",
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "firstName",
"type": "string",
"required": false
}
]
}
}
'import requests
url = "https://brew.new/api/v1/automations/triggers"
payload = {
"title": "User Signed Up",
"description": "Fires when a user completes signup.",
"payloadSchema": {
"type": "object",
"fields": [
{
"key": "email",
"type": "string",
"required": True
},
{
"key": "firstName",
"type": "string",
"required": False
}
]
}
}
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({
title: 'User Signed Up',
description: 'Fires when a user completes signup.',
payloadSchema: {
type: 'object',
fields: [
{key: 'email', type: 'string', required: true},
{key: 'firstName', type: 'string', required: false}
]
}
})
};
fetch('https://brew.new/api/v1/automations/triggers', 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/triggers",
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([
'title' => 'User Signed Up',
'description' => 'Fires when a user completes signup.',
'payloadSchema' => [
'type' => 'object',
'fields' => [
[
'key' => 'email',
'type' => 'string',
'required' => true
],
[
'key' => 'firstName',
'type' => 'string',
'required' => false
]
]
]
]),
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/triggers"
payload := strings.NewReader("{\n \"title\": \"User Signed Up\",\n \"description\": \"Fires when a user completes signup.\",\n \"payloadSchema\": {\n \"type\": \"object\",\n \"fields\": [\n {\n \"key\": \"email\",\n \"type\": \"string\",\n \"required\": true\n },\n {\n \"key\": \"firstName\",\n \"type\": \"string\",\n \"required\": false\n }\n ]\n }\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/triggers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"User Signed Up\",\n \"description\": \"Fires when a user completes signup.\",\n \"payloadSchema\": {\n \"type\": \"object\",\n \"fields\": [\n {\n \"key\": \"email\",\n \"type\": \"string\",\n \"required\": true\n },\n {\n \"key\": \"firstName\",\n \"type\": \"string\",\n \"required\": false\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/automations/triggers")
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 \"title\": \"User Signed Up\",\n \"description\": \"Fires when a user completes signup.\",\n \"payloadSchema\": {\n \"type\": \"object\",\n \"fields\": [\n {\n \"key\": \"email\",\n \"type\": \"string\",\n \"required\": true\n },\n {\n \"key\": \"firstName\",\n \"type\": \"string\",\n \"required\": false\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"triggerEventId": "tri_signup",
"title": "User Signed Up",
"description": "Fires when a user completes signup.",
"provider": "brew_api",
"payloadSchema": {
"type": "object",
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "firstName",
"type": "string",
"required": false
}
]
},
"createdAt": "2026-04-08T12:00:00.000Z",
"updatedAt": "2026-04-08T12:00:00.000Z"
}{
"error": {
"code": "PAYLOAD_SCHEMA_EMAIL_REQUIRED",
"type": "invalid_request",
"message": "payloadSchema.fields must declare { key: \"email\", type: \"string\", required: true }.",
"suggestion": "Add the required email field to payloadSchema.fields.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "payloadSchema"
}
}{
"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": "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
bearerAuthapiKeyAuth
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.
Required string length:
1 - 100Body
application/json
Response
Created. The bare trigger row.
Required string length:
1 - 256Required string length:
1 - 120Available options:
brew_api, clerk, stripe, shopify, stytch, supabase, workos, revenuecat, custom Show child attributes
Show child attributes
Maximum string length:
2000Was this page helpful?
⌘I