List automation triggers
LogsGET /automation-triggers
The trigger catalogue with field schemas and samples, for every rule editor
Returns every trigger event a rule can use, each with a description, the fields its conditions can test and, where available, a sample payload. Rule editors use it to build trigger and condition pickers, and a rule whose trigger.type is not in this catalogue is rejected on create and update. Requires automations:read.
Parameters
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Returns
200 Trigger catalogue
Show attributes
dataShow child attributes
eventdescriptionfieldsShow child attributes
nametypedescription
sample
Permissions automations:read · Roles: admin, analyst, customer_service, finance, operations, owner
curl -X GET "$BUSINESS_API/automation-triggers" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/automation-triggers", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/automation-triggers",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/automation-triggers", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
Response 200
{
"data": [
{
"event": "event",
"description": "Leitura confirmada no local.",
"fields": [
{
"name": "Ana Matsinhe",
"type": "active",
"description": "Leitura confirmada no local."
}
],
"sample": {}
}
]
}