Workflows

Cancel workflow

Changed on

When invoked for a workflow using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Can optionally be provided one or more recipients to scope the request to.

post/v1/workflows/{key}/cancel

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/workflows/{key}/cancel
  • Auth: HTTP bearer

Path parameters

keystring required

The key of the workflow to cancel.

Request body

cancellation_keystring required

A key that is used to reference a specific workflow trigger request when issuing a workflow cancellation request. Must be provided while triggering a workflow in order to enable subsequent cancellation. Should be unique across trigger requests to avoid unintentional cancellations.

Example request

{
  "cancellation_key": "cancel-workflow-123",
  "recipients": [
    "jhammond"
  ]
}

Response

No Content

Changes