Get Workflow Step Configuration

Read how a step in the workflow's draft is set up: the arguments its action gets, nested as the action's schema nests them, with {{ steps.<stepId>.output... }} references to earlier steps; its options; and the connection it runs with. issues lists what is missing or kept as stored.

GET

Path

Path parameters

stringrequired

The workflow's id, from List Workflows.

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.

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.