PT EN

Gatilhos de automação

URL base: $BUSINESS_API

O objecto

eventstring · opcional
descriptionstring · opcional
fieldsarray of object · opcional
Mostrar atributos filhos
namestring · opcional
typestring · opcional
descriptionstring · opcional
sampleobject · opcional
O objecto
{
  "event": "event",
  "description": "Leitura confirmada no local.",
  "fields": [
    {
      "name": "Ana Matsinhe",
      "type": "active",
      "description": "Leitura confirmada no local."
    }
  ],
  "sample": {}
}

Listar gatilhos de automação

Registos

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.

Parâmetros

limitinteger · consulta · opcional

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

afterstring · consulta · opcional

Opaque cursor returned by the previous page.

Devolve

200 Trigger catalogue

Mostrar atributos
dataarray of object · opcional
Mostrar atributos filhos
eventstring · opcional
descriptionstring · opcional
fieldsarray of object · opcional
Mostrar atributos filhos
namestring · opcional
typestring · opcional
descriptionstring · opcional
sampleobject · opcional

Permissões automations:read · Funções: admin, analyst, customer_service, finance, operations, owner

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