VocalDocscontracts 1.65.0

WorkflowTestResult

Each step of a Workflow test and the value after the last event (1.59.0): what the Workflow would do with the scripted completions. Ids, codes, the evaluations and the scripted values only.

An object with 9 fields.

Fields

FieldTypeRequiredDescription
ended_reasonEndedReason or nullyesHow the Call would end: workflow_complete once a hangup or end node was entered, the reason of a scripted session.ended, or null while it runs.
finalMachineStateyes
object"workflow_test"yes
outputsobject or nullnoThe Workflow's declared outputs (1.60.0): the outputs expressions of the hangup or end node the run entered, evaluated over its value; null while it runs or when that node declares none. Content of the scripted values. Absent from an api before 1.60.0.
patharray of MachineIdyesEvery node the run entered or evaluated, in order.
stepsarray of WorkflowTestStepyesThe start, then one step per scripted event.
versioninteger or nullyesThe version run; null for the draft.
waiting_onMachineId or nullyesThe node whose completion the run waits for after the last event; null when it ended.
workflow_idWorkflowIdyes

Used by

The operations whose parameters, request body or responses name this shape directly.