Update Workflow Trigger Configuration

Change how a trigger in the workflow's draft is set up. Only what you send changes: objects merge key by key, an array replaces, and null removes. An app trigger's values are checked against its action's schema at the trigger's app version; a Schedule takes { type, everyMinutes, days, times, timeZone, environments }, a Webhook { waitForCompletion, processInOrder, forwardHeaders, customUrl, response, environments }, When called the option allowConcurrentRuns, and a polling trigger the option pollIntervalMs (GET .../schema lists each with its choices). A schedule, a custom URL and a polling interval change their live rows at once, as in the editor; a webhook's other settings run once the workflow is published. 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

object

Arguments to set, nested as the action's schema nests them, or a built-in trigger's settings.

Arguments to set, nested as the schema nests them. Objects merge key by key; an array replaces; null removes. null for the whole object clears every argument.

object

Options to set.

Options to set: pagination, filter, sort, retries, onFailure, onNoResults, onSuccess. Sending one turns it on; null turns it off, as deleting it in the editor does. Objects merge key by key.

object

The connection to run with, or null for none.

{ "mode": "connection", "connectionId": "...", "rules": [...] }, { "mode": "environment" }, { "mode": "installation" } (integration workflows), or null for none. Replaced whole.

Response fields

argumentsobject

The action's arguments, nested as the action's schema nests them. A string may hold {{ ... }} references to earlier steps' output.

optionsobject

Step options: pagination, filter, sort, retries, onFailure, onNoResults, onSuccess. An option present is on; one left out is off.

connectionobject

The connection the step runs with. Null when none is set or the app takes none.

modestring
connection: a chosen connection; environment: the workflow's connection for the run's environment; installation: each installation's own (integration workflows).
- connection
- environment
- installation
connectionIdstring
The connection's id, from List Connections. Null with rules and no default.
rulesobject
Conditions that pick another connection, first match wins: a list of { when: { field, operator, value }, connectionId }, or { $legacy } when kept as stored.

isConfiguredboolean

Whether the editor considers the step set up (nothing required is missing). A draft may be saved incomplete.

issuesarray of objects

Warnings about the stored configuration: required values missing, values kept as stored, connections that are gone.

severitystring
error refuses a write; warning does not.
- error
- warning
codestring
What is wrong, UPPER_SNAKE (REQUIRED_MISSING, LEGACY_VALUE_PRESERVED, INVALID_REFERENCE, ...).
pathstring
Where, as a JSON Pointer into the configuration (/arguments/contact/FirstName).
messagestring
What is wrong, for a person.

revisionstring

The draft's revision: send it in If-Match on your next change to the draft.