curl --request GET \
--url https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract', 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/{triggerEventId}/contract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"subjectKind": "trigger",
"subjectId": "tri_signup",
"source": "stored",
"typeName": "UserSignedUpPayload",
"contractHash": "22545d11e1d174ba0717ed37c9c4b460c96bed51ae31ea0af18266ebba30f76a",
"version": 2,
"enforcement": "off",
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "plan",
"type": "enum",
"required": false,
"enumValues": [
"free",
"pro"
],
"fallbackValue": "free"
},
{
"key": "order",
"type": "object",
"required": false,
"children": [
{
"key": "total",
"type": "float",
"required": true
}
]
}
]
}{
"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": "format"
}
}{
"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": "TRIGGER_EVENT_NOT_FOUND",
"type": "not_found",
"message": "Trigger event 'tri_xxx' was not found.",
"suggestion": "List triggers with GET /v1/automations/triggers.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "triggerEventId"
}
}{
"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"
}
}Get a trigger payload contract
The payload contract for the trigger: the STORED contract when one has been declared (source: "stored", with contractHash, version, enforcement), otherwise the derived one (source: "derived_from_schema", built from the trigger’s flat payloadSchema).
Contract fields form a tree: scalars (string | int | float | boolean | date | enum), object nodes with children, and array nodes with children (element object shape) or itemType (scalar elements). Derived contracts may carry type: "unknown" where no type evidence exists.
Pass ?format= for generated artifacts instead of the JSON contract.
curl --request GET \
--url https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract', 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/{triggerEventId}/contract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/automations/triggers/{triggerEventId}/contract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"subjectKind": "trigger",
"subjectId": "tri_signup",
"source": "stored",
"typeName": "UserSignedUpPayload",
"contractHash": "22545d11e1d174ba0717ed37c9c4b460c96bed51ae31ea0af18266ebba30f76a",
"version": 2,
"enforcement": "off",
"fields": [
{
"key": "email",
"type": "string",
"required": true
},
{
"key": "plan",
"type": "enum",
"required": false,
"enumValues": [
"free",
"pro"
],
"fallbackValue": "free"
},
{
"key": "order",
"type": "object",
"required": false,
"children": [
{
"key": "total",
"type": "float",
"required": true
}
]
}
]
}{
"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": "format"
}
}{
"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": "TRIGGER_EVENT_NOT_FOUND",
"type": "not_found",
"message": "Trigger event 'tri_xxx' was not found.",
"suggestion": "List triggers with GET /v1/automations/triggers.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "triggerEventId"
}
}{
"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
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.
1 - 64Path Parameters
Trigger id returned by POST /v1/automations/triggers (integration triggers use composite ids — URL-encode the colons).
1 - 256"tri_signup"
Query Parameters
Rendering. json (default) returns the contract object; ts | zod | jsonschema | skill return {format, content} — a generated TypeScript type, Zod schema, JSON Schema document, or SKILL.md wiring brief.
json, ts, zod, jsonschema, skill Response
The contract (format=json, default) or {format, content} for text formats.
trigger 1stored, derived_from_schema, derived_from_template 1json, ts, zod, jsonschema, skill 64x >= 1off, prune, strict fresh, stale Show child attributes
Show child attributes
Was this page helpful?