Skip to main content

RunWorkflow

Stored in the runworkflows collection. createdAt and updatedAt are maintained automatically.

Returned by DELETE /workflow/runs, GET /workflow/runs, DELETE /workflow/runs/:runId, POST /workflow/runs/:runId/restart.

FieldTypeNotes
workflowObjectId -> Workflowrequired
companyObjectId -> Companyrequired
workflowVersionnumberrequired
workflowSnapshotanyrequired
statusstringdefault queued · one of queued, running, waiting, delayed, paused, completed, failed, cancelled
triggerEventTypestring
triggerDetailsanydefault {}
currentNodeKeystring
currentParentNodeKeystring
completedNodeHistoryobject[]default []
completedNodeHistory.nodeKeystring
completedNodeHistory.typestring
completedNodeHistory.statusstring
completedNodeHistory.startedAtdate
completedNodeHistory.completedAtdate
completedNodeHistory.outputany
completedNodeHistory.errorstring
actionExecutionsobject[]default []
actionExecutions.nodeKeystring
actionExecutions.typestring
actionExecutions.labelstring
actionExecutions.statusstring
actionExecutions.executedAtdate
actionExecutions.completedAtdate
actionExecutions.messageIdsmixed[]default []
actionExecutions.outputany
actionExecutions.errorstring
previousExecutedNodeKeysstring[]default []
previousSuccessfulActionNodeKeysstring[]default []
immediateExecutableNodesobject[]default []
immediateExecutableNodes.nodeKeystring
immediateExecutableNodes.edgeKeystring
immediateExecutableNodes.parentNodeKeystring
immediateExecutableNodes.transitionTypestring
immediateExecutableNodes.eventTypestring
immediateExecutableNodes.conditionsmixed[]default []
immediateExecutableNodes.waitConfiganydefault {}
immediateExecutableNodes.timeoutConfiganydefault {}
contextanydefault {}
waitingEventanydefault null
timeoutAtdate
lockedAtdate
workerIdstring
pauseRequestedbooleandefault false
cancelRequestedbooleandefault false
errorstring
completedAtdate
_idObjectIddefault "6a95712f932657988a91c0cf"
createdAtdateset once
updatedAtdate