Test Workflow Step

Run one step of the workflow's draft on its own, exactly as Run in the editor does: with its saved configuration and connection, the saved sample outputs of the steps it references, and real side effects (a create step creates). The output is saved as the step's sample, which later steps' references and their tests read; a step that fails answers status failed with the error, not an HTTP error. A Loop, Wait, Flow control, Respond to webhook, Continue or Break step only runs inside a workflow run, and a Run workflow step, which queues another workflow's run, is not tested on its own. A function step's test checks the connections of the function's own steps too. Saving the sample changes the draft's revision: use meta.revision on your next change.

POST

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.

Body

Arguments

string

The environment to run in, from List Environments. Defaults to the company's default environment.

The environment to run in, from List Environments. Left out, the company's default environment.

Response fields

statusstring

succeeded or failed: whether the step ran without an error.

succeeded
failed

outputobject

The first records of the output (a JSON array as the step answered it), capped at 200 records and about 60 KB. Empty when there is no sample.

totalnumber

How many records the output had in all. Null when there is no sample.

outputFieldsarray of objects

The fields of the output records, learned from the sample and offered to later steps.

keystring
The field's path in each record: dotted, with [] marking an array (lines[].sku). Reference it as {{ steps.<stepId>.output[0].<key> }}.
typestring
Its type as seen in the sample: string, number, boolean, object, date, a type with [] for an array, or mixed.

errorobject

Why the run failed. Null unless status is failed.

codestring
The runtime's error code (ARGUMENTS_MISSING, 401_UNAUTHORIZED, DEFAULT, ...).
messagestring
What the code means, for a person. What the app answered, if anything, is in output.
statusnumber
The HTTP status the app answered, when it answered one.

savedOndate

When the sample was saved. Null when there is none.

revisionstring

The draft's revision after the sample was saved (a sample is part of the step): send it in If-Match on your next change to the draft.

durationMsnumber

How long the step took to run, in milliseconds.