Skip to content
Developer Preview

workflow/cancel

Cancels a live workflow run; admission-only bare ack, the cancellation’s truth arrives as the workflow item’s view events.

Type: WorkflowCancelParams

workflow/cancel params: cancel a live workflow run.

Field Type Stability Presence Description
commandId string required The idempotency handle (UUIDv7).
sessionId string required The target session.
workflowRunId string required The run to cancel, exactly as the workflow item names it; required, non-empty.
Source

schema/msp/experimental/msp.schema.json#/methods/workflow~2Fcancel

{
"description": "Cancels a live workflow run; admission-only bare ack, the cancellation's truth arrives as the workflow item's view events.",
"params": {
"$ref": "#/$defs/WorkflowCancelParams"
},
"result": {
"$ref": "#/$defs/WorkflowControlResult"
}
}