webhooks

Cancel a webhook waiter

Changed on

Cancel a waiter. It stops matching deliveries, frees its slot toward the endpoint's limit, and fails the run's wait. If a delivery already claimed the waiter, the cancel is too late: the response has cancelled: false with reason: "too_late", and the run resumes with that delivery's event.

post/api/v1/webhooks/waiters/{waiterId}/cancel

Request

Response

Successful request

cancelledboolean required
reason'too_late'

Present when cancelled is false. A delivery already claimed the waiter.

deliveryIdstring

With too_late, the delivery that resumed the run.

Example response

{
  "deliveryId": "whd_1234"
}

Changes