Automation triggers

Base URL: $BUSINESS_API

The object

eventstring · optional
descriptionstring · optional
fieldsarray of object · optional
Show child attributes
namestring · optional
typestring · optional
descriptionstring · optional
sampleobject · optional
The object
{
  "event": "event",
  "description": "Leitura confirmada no local.",
  "fields": [
    {
      "name": "Ana Matsinhe",
      "type": "active",
      "description": "Leitura confirmada no local."
    }
  ],
  "sample": {}
}

List automation triggers

Logs

GET /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

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Trigger catalogue

Show attributes
dataarray of object · optional
Show child attributes
eventstring · optional
descriptionstring · optional
fieldsarray of object · optional
Show child attributes
namestring · optional
typestring · optional
descriptionstring · optional
sampleobject · optional

Permissions automations:read · Roles: admin, analyst, customer_service, finance, operations, owner

curl -X GET "$BUSINESS_API/automation-triggers" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "event": "event",
      "description": "Leitura confirmada no local.",
      "fields": [
        {
          "name": "Ana Matsinhe",
          "type": "active",
          "description": "Leitura confirmada no local."
        }
      ],
      "sample": {}
    }
  ]
}