Cancellations

View as Markdown

A cancellation removes all future delivery attempts for an event from the queue. Cancellations can be triggered manually on any event to prevent it from being delivered to its destination.

Cancellations

Cancellations override any automatic retry rule. Cancelled events will not be delivered unless manually retried.

Manually cancel events

Manually canceling events allows you to prevent an event from being delivered to its destination, either because it's currently queued, paused, delayed or has a scheduled next attempt.

Manual cancellations can be triggered individually or in bulk.

Cancel a single event

  1. Locate the event you wish to cancel and click it to select it.
  2. In the right-hand panel that appears, click Cancel.
PUT
/2025-07-01/events/:id/cancel
Response example
JSON 
{
  "webhook_id": "web_4fic4uPSgYND",
  "team_id": "tm_7Rg2X1IGUlMk",
  "source_id": "src_oenfgoe2x8bxlc",
  "destination_id": "des_S3lY1sPyBMUL",
  "event_data_id": "edt_6yn9MnkkFJ0s7D8P05l9",
  "request_id": "req_cfRBpUUTaTlPcPG1rJk4",
  "cli_id": null,
  "attempts": 1,
  "status": "SUCCESSFUL",
  "id": "evt_smKHihPVI10wx9c2RC",
  "last_attempt_at": "2025-09-17T02:32:34.984Z",
  "next_attempt_at": null,
  "response_status": 200,
  "error_code": null,
  "successful_at": "2025-09-17T02:32:35.077Z",
  "created_at": "2025-09-17T02:32:34.953Z",
  "updated_at": "2025-09-17T02:33:00.443Z"
}

See the cancel event API reference for more details.

Cancel many events

Bulk cancellation are triggered for a set of events based on a filters, either through the UI or the dashboard.

  1. Locate a list of events you wish to cancel, either by filtering your event list or opening a custom event view.
  2. Click Bulk cancel.
  3. Click Cancel all.
  4. Optional: If you need to abort a bulk cancellation, click Bulk cancel, click the Ongoing tab, select the cancellation you'd like to abort, and click Abort.
POST
/2025-07-01/bulk/events/cancel
Request body example
JSON 
{
  "query": {
    "source_id": [
      "src_cqafb6kbv27dih"
    ]
  }
}
Response example
JSON 
{
  "team_id": "tm_MbvJvdnbCgHz",
  "type": "events.cancel",
  "query": {
    "source_id": [
      "src_cqafb6kbv27dih"
    ]
  },
  "estimated_batch": null,
  "estimated_count": 1,
  "completed_count": 0,
  "number": 2,
  "id": "bch_hKCDD7cKhyE9JN",
  "created_at": "2025-09-17T17:21:46.327Z",
  "updated_at": "2025-09-17T17:21:46.327Z",
  "completed_at": null,
  "cancelled_at": null,
  "processed_batch": 0,
  "failed_count": null,
  "in_progress": true,
  "progress": 0
}

See the bulk cancel event API reference for more details.

Hookdeck will now remove all future delivery attempts for the selected events. These events will remain in your event history but will not be delivered to their destinations.

Abort scheduled cancellations

Aborting a scheduled cancellation will stop an ongoing bulk cancellation process and preserve the remaining events in the queue.

  1. Navigate to your events page and click Bulk cancel.
  2. Click the Ongoing tab to view active bulk cancellations.
  3. Select the cancellation operation you wish to abort.
  4. Click Abort.
POST
/2025-07-01/bulk/events/cancel/:id/cancel
Response example
JSON 
{
  "team_id": "tm_MbvJvdnbCgHz",
  "type": "events.cancel",
  "query": {
    "source_id": [
      "src_cqafb6kbv27dih"
    ]
  },
  "estimated_batch": null,
  "estimated_count": 1,
  "completed_count": 0,
  "number": 2,
  "id": "bch_hKCDD7cKhyE9JN",
  "created_at": "2025-09-17T17:21:46.327Z",
  "updated_at": "2025-09-17T17:21:46.327Z",
  "completed_at": null,
  "cancelled_at": "2025-09-17T17:21:46.327Z",
  "processed_batch": 0,
  "failed_count": null,
  "in_progress": true,
  "progress": 0
}

See the abort bulk cancellation API reference for more details.

Identifying cancelled events

Cancelled events will appear in your event history with a "Cancelled" status. These events can still be viewed for audit purposes but will not have any pending delivery attempts. In the case of an event that has already been delivered, the status will be reverted to its last known status.

Restoring cancelled events

Once an event has been cancelled you can still manually retry a cancelled event if you need to deliver it to its destination afterall.

<- Previous Retries Next -> Requests