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

workflowUrl

string

Filter by exact workflow URL.

workflowRunId

string

Filter by workflow run ID.

label

string | string[]

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

fromDate

Date | number

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

toDate

Date | number

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

callerIp

string

Filter by the IP address that triggered the workflow.

flowControlKey

string

Filter by flow control key.

workflowCreatedAt

number

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

failureFunctionState

string

Filter by failure callback state.

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();

// 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(),
    workflowUrl: "https://your-endpoint.com",
    label: "my-workflow",
  }
});

Getting Started

Core Concepts

Features

Agents

API Reference

Resources

Arguments

Response

Usage

​Arguments

​Response

​Usage

Arguments

Response

Usage