client.dlq.list - Upstash Documentation

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

cursorbodystring

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

countbodynumber

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

filterbodyobject

Filter options for narrowing down DLQ messages.

workflowUrlbodystring

Filter by exact workflow URL.

workflowRunIdbodystring

Filter by workflow run ID.

labelbodystring | string[]

Filter by workflow label. Pass an array to match runs that have any of the given labels (OR semantics).

fromDatebodyDate | number

Earliest date to include. Accepts Date objects or Unix timestamps (ms).

toDatebodyDate | number

Latest date to include. Accepts Date objects or Unix timestamps (ms).

callerIpbodystring

Filter by the IP address that triggered the workflow.

flowControlKeybodystring

Filter by flow control key.

workflowCreatedAtbodynumber

Filter by workflow creation time (Unix timestamp in ms).

failureFunctionStatebodystring

Filter by failure callback state.

Response

messagesDLQMessage[]

An array of DLQ messages that match the provided filters.

cursorstring

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 messagesconst { messages, cursor } = await client.dlq.list();// List with pagination and filteringconst result = await client.dlq.list({  cursor,  count: 10,  filter: {    fromDate: Date.now() - 86400000, // last 24 hours    toDate: Date.now(),    workflowUrl: "https://your-endpoint.com",    label: "my-workflow",  }});