Queues

Cancel all pending delivery attempts for a destination.

Purge Queue

DELETE /api/v1/queues/{destinationId}

Cancels every pending delivery for a destination by marking its Pending and WaitingRetry events as Cancelled. HookSentry uses a single-queue architecture, so a selective RabbitMQ purge by destination isn't possible — this is a soft cancel, and the Worker silently discards messages for cancelled events when they arrive.

Auth: Bearer token — Admin or Owner role

Path parameters

ParameterTypeDescription
destinationIdUUIDUUID of the destination whose queue is purged

Irreversible:

Purging is permanent. Events with status Processing, Succeeded, CriticalFailure, or AuthenticationFailed are not affected — require explicit confirmation in your UI before calling this endpoint.

var request = new HttpRequestMessage(HttpMethod.Delete, $"https://api.hooksentry.com/api/v1/queues/{destinationId}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);

using var client = new HttpClient();
var response = await client.SendAsync(request);

Return codes

  • 204 No Content — queue purged successfully
  • 401 Unauthorized — missing, invalid token, or missing role claim
  • 403 Forbidden — caller is not Admin/Owner, or the destination belongs to another tenant
  • 404 Not Found — destination not found