Skip to content
ActionCircleCIUpdated May 2026

How do I cancel a CircleCI workflow?

Short answer: Drop the "CircleCICancel Workflow" action anywhere in your workflow, map the inputs from upstream nodes, and publish.

Inputs

The fields this action accepts.

Every field can be mapped from an upstream trigger, AI step, table row, or hard-coded literal.

FieldTypeRequiredDescription
Workflow ID
workflow_id
stringRequiredWorkflow ID. Example: wf-abc-123
Sample request
{
"workflow_id": "e.g. wf-abc-123"
}
Returns
{
"message": "Accepted."
}

Use these fields in downstream nodes for routing, logging, or error handling.

Triggered by

Apps that pair well as the trigger for Cancel Workflow.

Any of these apps can fire this action as part of a workflow.

FAQ

Questions about Cancel Workflow.

What does the Cancel Workflow action do in CircleCI?
Stops an in-flight workflow. Useful for "downstream check failed, short-circuit the rest of the pipeline" cascading workflows or for emergency stop on accidental production deploys.
What inputs does Cancel Workflow require?
Required: Workflow ID. Every input accepts a static value or a variable from any upstream node in your workflow.
Can I use dynamic inputs from earlier workflow nodes?
Yes. Any field on this action can pull values from upstream nodes, whether that's a form response, a trigger payload, an AI output, or a lookup result.
What happens if CircleCI returns an error?
The workflow pauses on the failed node, the error message is captured in the run log, and you can retry the run with one click. Auto-retry policies are configurable per workflow with exponential backoff up to 5 attempts.
Does Cancel Workflow support batch operations?
Yes. Run Cancel Workflow inside a Loop node to process arrays. Tiny Command handles CircleCI's rate limits automatically so you don't have to throttle manually.
More actions

Other CircleCI actions.

Send cancel workflow from your workflows.

Triggered by anything in the catalog. Free tier available. No credit card.