Validate Workflow Step Configuration

Send what you would send to Update Workflow Step Configuration and see what it would do: valid is false with every error in issues, or true with the configuration it would leave and the required values still missing. Nothing changes.

POST

Path

Path parameters

stringrequired

The workflow's id.

stringrequired

The step's id, from List Workflow Steps or Get Workflow Definition.

Headers

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.

Body

Arguments

object

Arguments to check.

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 check.

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

A connection to check, or null.

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

Response fields

validboolean

True when Update would accept the change.

configurationobject

The configuration the change would leave, before it is saved.

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.

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 revision of the draft that was checked.