Listar Mensajes DLQ

Utilice este endpoint para listar los mensajes actualmente en la dead-letter queue de webhooks, con alcance al tenant del llamador. El tenant se deriva del JWT bearer (claim tenantId), nunca de un header de solicitud.

Esta ruta solo se monta cuando la autenticación está habilitada y un inspector de DLQ está configurado. De lo contrario, no se expone y cualquier solicitud es rechazada con 503.

GET /v1/transfers/webhooks/dlq

Listar Mensajes DLQ

cURL

curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/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

Authorization · string · header · requerido

Autenticación mediante token JWT Bearer. El tenantId se deriva del token bearer o del contexto autenticado de la solicitud y no se proporciona a través de X-Organization-Id.

Encabezados

X-Organization-Id · string<uuid>

Alcance de organización Midaz para la solicitud. En despliegues multi-tenant este header es obligatorio. Este no es el identificador del tenant; el tenantId se deriva del JWT bearer o del contexto autenticado. En despliegues single-tenant los valores de X-Organization-Id proporcionados por el llamador son rechazados y la organización es proporcionada por SINGLE_TENANT_ORGANIZATION_ID.

Parámetros de consulta

limit · integer · predeterminado: 50

Número máximo de mensajes a devolver.

Rango requerido: 1 <= x <= 200

offset · integer · predeterminado: 0

Número de mensajes a omitir para paginación.

Rango requerido: x >= 0

Respuesta

200

application/json

Indica que la página de mensajes DLQ fue devuelta exitosamente.

messages · object[] · requerido

Show child attributes

totalCount · integer · requerido

Cantidad de mensajes filtrados por tenant visitados durante este escaneo. Cuando hasMore es true, este es un límite inferior best-effort sobre la profundidad real de la DLQ para este tenant, no el conteo total.

Rango requerido: x >= 0

Ejemplo:

1

returnedCount · integer · requerido

Número de mensajes en esta página después de aplicar offset y limit.

Rango requerido: x >= 0

Ejemplo:

1

returned · integer

Número de mensajes devueltos en esta página.

Rango requerido: x >= 0

Ejemplo:

1

hasNextPage · boolean

Indica si hay más mensajes visibles para el tenant más allá de esta página.

Ejemplo:

false

hasMore · boolean

True cuando el inspector detuvo el escaneo temprano después de llenar la página actual.

Ejemplo:

false

warning · string

Definido cuando la paginación puede ser no determinística (p. ej., el acceso concurrente desplaza el ordenamiento).

Ejemplo:

"pagination may be non-deterministic under concurrent access"