Docs

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 revision you last read: the revision from its read (Get Workflow Definition for a workflow, Get Analytics Page Definition for an Analytics page, Get Analytics Data Source Table for a fixed source's table), or meta.revision from your last change to it. The ETag header of either answer is the same value, ready to send back. The change applies only if nobody changed it 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 the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See 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. For a built-in trigger (Schedule, Webhook, When called), the version of the built-in app it was added with, "0" or "0.0.1" (some older ones hold "draft" or null); it does not change what the trigger does.

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.