Workflow Triggers

Cancel workflow

Changed on

Cancels a previously triggered workflow using the provided cancellation key.

post/v1/notify/cancel

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/notify/cancel
  • Auth: HTTP bearer

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.

namestring required

The key of the workflow to cancel.

Example request

{
  "cancellation_key": "comment_123",
  "name": "new-comment",
  "recipients": [
    "user_456"
  ]
}

Response

No Content

Changes