Skip to main content
npayload is launching soon.
npayloadDocs
API ReferenceDead letter queue

List DLQ entries

Returns failed messages in the dead letter queue.

GET/v1/subscriptions/{subscriptionId}/dlq

Authorization

ApiKeyAuth
AuthorizationBearer <token>

API key authentication. Keys are prefixed with environment:

  • npk_live_ for production
  • npk_test_ for testing/staging

In: header

Path Parameters

subscriptionId*string

Subscription ID

Query Parameters

cursor?string

Pagination cursor for next page

limit?integer

Maximum number of items to return

Default20
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "https://api.npayload.com/v1/subscriptions/string/dlq"
{
  "data": [
    {
      "id": "string",
      "messageId": "string",
      "subscriptionId": "string",
      "failedAt": "2019-08-24T14:15:22Z",
      "reason": "string",
      "attempts": 0,
      "payload": {}
    }
  ],
  "pagination": {
    "cursor": "string",
    "hasMore": true
  },
  "stats": {
    "total": 0,
    "oldest": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

Was this page helpful?