List Workflow Triggers

List what starts a workflow. A workflow can have several triggers: a schedule, a webhook, an app event, or another workflow calling it.

GET

Path

Path parameters

stringrequired

The workflow's id, from List Workflows.

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.

Arguments

string

draft (the default), published, or a version label from List Workflow Versions.

draft (the default, what the editor shows), published (what runs), or a version label from List Workflow Versions, such as 0.0.14.

Default: draft

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

idstring

The trigger's id.

namestring

The trigger's display name.

appSlugstring

What starts the workflow: schedule, webhook, runWorkflow (when another workflow calls it), or the app whose event does.

appVersionstring

The app version the trigger is pinned to. "0" for built-in triggers.

actionIdstring

The app event the trigger listens for. Null for a built-in trigger.

isDisabledboolean

True when the trigger is turned off.

isConfiguredboolean

Whether the trigger passed the editor's validation. Null when it was never validated.