Update Workflow Trigger

Rename a trigger in the workflow's draft, or turn it off or on. Send the revision you last read in If-Match; the response's meta.revision is the new one.

PUT

Path

Path parameters

stringrequired

The workflow's id.

stringrequired

The trigger's id, from List Workflow Triggers.

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

string

A new display name, or null for the default.

A new display name. null goes back to the default name.

boolean

true to stop it starting runs.

true turns the trigger off: it no longer starts runs.

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.