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#

cursorstring#

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

countnumber#

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

filterobject#

Filter options for narrowing down DLQ messages.

Show properties

workflowUrlstring#

Filter by exact workflow URL.

workflowRunIdstring#

Filter by workflow run ID.

labelstring | string[]#

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

fromDateDate | number#

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

toDateDate | number#

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

callerIpstring#

Filter by the IP address that triggered the workflow.

flowControlKeystring#

Filter by flow control key.

workflowCreatedAtnumber#

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

failureFunctionStatestring#

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",  }});