Get Workflow Trigger Schema

Read what a trigger's configuration takes before you set it: its action's arguments as a tree with their types, choices and required ones; the options the action supports and their limits; the connection it needs; and the output fields later steps can reference. It describes the app version the trigger uses. A Schedule, Webhook or When called trigger lists its own settings, with their defaults and choices, and has no action.

GET

Path

Path parameters

stringrequired

The workflow's id, from List Workflows.

stringrequired

The trigger's id, from List Workflow Triggers.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Response fields

appobject

The trigger's app and the version it uses.

slugstring
The app's slug.
versionstring
The app version the trigger uses.

actionobject

The action the trigger runs; null for a built-in trigger (Schedule, Webhook, When called).

idstring
The action's id.
namestring
The action's name.
operationstring
read, create, update, delete, or null.
kindstring
action or trigger.
- action
- trigger

argumentsobject

The arguments, as a tree: key, label, type, required, and when they apply itemType, description, placeholder, default, advanced, sensitive, multiple, mappable, customFields, choices and children.

optionsobject

Each option (pagination, filter, sort, retries, onFailure, onNoResults, onSuccess): supported, and what it accepts.

connectionobject

The connection the trigger needs.

requiredboolean
Whether the app needs a connection.
authTypestring
The app's authentication type.
modesarray
The connection modes this trigger accepts.

outputobject

The output fields the action declares, which later steps reference.

fieldsarray
Each declared field: key, type, description.
- keystring
  The field's path.
- typestring
  The field's type.
- descriptionstring
  What the field holds.