Add Workflow Trigger

Add a trigger to the workflow's draft. A schedule starts every hour, every day, until you change it; a webhook gets its URL at once, answered in webhookUrl. Send the revision you last read in If-Match; the response's meta.revision is the new one.

POST

Path

Path parameters

stringrequired

The workflow's id.

Headers

Optional headers

stringrequired

Required. The draft revision you last read (the revision from Get Workflow Definition, or meta.revision from your last change). The change applies only if nobody changed the draft since: otherwise it answers 412 with the current revision in error.details.revision. Send it as a strong entity tag ("r_..."): a weak one (W/"...") never matches and answers 412. Without it the request answers 428.

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.

Body

Arguments

stringrequired

schedule, webhook, runWorkflow, or an app slug.

schedule, webhook, runWorkflow (When called: another workflow calls this one), or an app with trigger actions (List Universal Apps, usableAsTrigger=true).

string

latest, or a version number.

latest (the default) pins the current published version. A version number pins that version.

string

An app event's trigger id or slug.

For an app event: the trigger's id or slug (List Universal Actions, kind=trigger). Built-ins take none.

string

The trigger's display name.

The step's display name. Left out, it is named the way the editor names it.

Response fields

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.

webhookUrlstring

For a webhook trigger, the URL that starts the workflow. Null for other triggers.