client.dlq.list

The dlq.list method retrieves messages that were sent to the Dead Letter Queue (DLQ).

DLQ messages represent failed workflow or QStash deliveries that could not be retried successfully.

Arguments

cursor · string

A pagination cursor from a previous request. Use this to fetch the next batch of results.

count · number

Maximum number of DLQ messages to return. Defaults to a system-defined limit if not provided.

filter · object

Filter options for narrowing down DLQ messages

Hide child attributes

fromData · number

Earliest timestamp (Unix ms) to include.

toDate · number

Latest timestamp (Unix ms) to include.

url · number

Filter messages that targeted a specific URL.

responseStatus · number

Filter by HTTP response status code.

Response

messages · DLQMessage[]

An array of DLQ messages that match the provided filters.

cursor · string

A cursor to paginate through additional results. If not returned, you have reached the end of the DLQ.

Usage

import { Client } from "@upstash/workflow";

const client = new Client({ token: "<QSTASH_TOKEN>" });

// 👇 List all DLQ messages
const { messages, cursor } = await client.dlq.list({ filter: dlqFilters });

// 👇 List with pagination and filtering
const result = await client.dlq.list({
  cursor,
  count: 10,
  filter: {
    fromDate: Date.now() - 86400000, // last 24 hours
    toDate: Date.now(),
    url: "https://your-endpoint.com",
    responseStatus: 500
  }
});