Skip to main content
The WorkflowRunState object represents the current state of a workflow run started from the Customer API, such as a guided onboarding or cancellation flow. It tracks the run’s status, any interaction currently awaiting a customer response, and the outcome once the run completes.

Reference

workflowId
string
required
workflowVersion
number
required
runId
string
required
runVersion
number
required
status
enum<string>
required
Available options:
running,
waiting_interaction,
completed,
failed,
cancelled
pendingInteraction
object
interactiveSteps
object[]
result
object
error
object
invalidatedResources
string[]
outcome
object
completionData
object