List DLQ Messages

Use this endpoint to list messages currently in the webhook dead-letter queue, scoped to the caller’s tenant. The tenant is derived from the bearer JWT (tenantId claim), never from a request header.

This route is only mounted when authentication is enabled and a DLQ inspector is configured. Otherwise it is not exposed and any request is rejected with 503.

GET /v1/webhooks/dlq

List DLQ Messages

cURL

curl --request GET \
  --url https://api.example.com/v1/webhooks/dlq \
  --header 'Authorization: Bearer <token>'

200

page

{
  "messages": [
    {
      "messageId": "019c96a0-d1d2-7e3f-4a5b-6c7d8e9f0a1b",
      "routingKey": "webhook.transfer.completed",
      "deathReason": "rejected",
      "failureReason": "HTTP 500 from subscriber",
      "tenantId": "11111111-1111-1111-1111-111111111111",
      "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
      "eventType": "transfer.completed",
      "correlationId": "019c96a0-cc10-7abc-d1e2-3f4a5b6c7d8e",
      "retryCount": 5,
      "manualRetryCount": 1,
      "timestamp": "2026-02-01T15:35:00-03:00"
    }
  ],
  "totalCount": 1,
  "returnedCount": 1,
  "returned": 1,
  "hasNextPage": false,
  "hasMore": false
}

Autorizaciones

BearerAuthOAuth2ClientCredentialsOAuth2Password

Authorization · string · header · requerido

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Scopes

api · OAuth2ClientCredentials

TED transfer API access

api · OAuth2Password

TED transfer API access

Parámetros de consulta

limit · integer · predeterminado: 50

Maximum number of messages to return.

Rango requerido: 1 <= x <= 200

offset · integer · predeterminado: 0

Number of messages to skip for pagination.

Rango requerido: x >= 0

Respuesta

200

application/json

Indicates the DLQ messages page was returned successfully.

messages · object[] · requerido

Show child attributes

totalCount · integer · requerido

Tenant-filtered message count visited during this scan. When hasMore is true this is a best-effort lower bound on the true DLQ depth for this tenant, not the full count.

Rango requerido: x >= 0

Ejemplo:

1

returnedCount · integer · requerido

Number of messages in this page after offset and limit are applied.

Rango requerido: x >= 0

Ejemplo:

1

returned · integer

Number of messages returned in this page.

Rango requerido: x >= 0

Ejemplo:

1

hasNextPage · boolean

Whether there are more tenant-visible messages beyond this page.

Ejemplo:

false

hasMore · boolean

True when the inspector stopped scanning early after filling the current page.

Ejemplo:

false

warning · string

Set when pagination may be non-deterministic (e.g., concurrent access shifts ordering).

Ejemplo:

"pagination may be non-deterministic under concurrent access"