Skip to main content
POST
Run a flow up to a step on a real record, in a sandbox

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

flow_id
string
required

Body

application/json
record
FlowTestRecord · object

The record the trigger runs on (its id); leave it out for a schedule, which runs for no record

simulate
Simulate · object

Answers for waiting steps, by step id, so the steps after them run: an approval true (approved as prepared) or the edited data; a sleep any value; an email reply the reply text, or false for no reply. A waiting step with no answer ends its branch and shows in waits.

until
string | null

The last step to run; none runs every step

Response

200 - application/json

Successful Response

flow_id
string
required
order
string[]
required
passed
boolean
required

Every step ran without an error, apart from steps on a branch not taken, and nothing in warnings fails the test (a full test marks the version tested)

skipped
string[]
required

Outside calls a test does not make

steps
Steps · object
required
until
string | null
required
version
integer
required
would_send
Would Send · object[]
required

What the steps would have sent; none was sent

held_events
Held Events · object[]

Events the steps raised (a task created) that a test does not publish

not_taken
string[]

Steps on a branch a condition did not take for this record: they did not run, and need not

trigger_matches
boolean | null

Whether the record is in the trigger's audience now. false: the hourly job would not start the flow for it, so no step ran; pick a record that matches. null: the trigger has no audience to check

waits
Waits · object[]

Steps that would wait (an approval, a sleep, an email reply): what for, and whether simulate answered

warnings
string[]

What the steps' own results don't show: a condition that found no such field, an approval no one would be asked for (fails the test), a step that waited on rows another run holds (fails the test)

would_write
Would Write · object[]

Rows the steps wrote inside the test (a task, a comment, a field value): table, insert/update/delete and the values; all were undone when the test ended