client.dlq.resume

The dlq.resume method resumes one or more workflow runs from the Dead Letter Queue (DLQ) at the point where they previously failed. This allows you to continue execution from the failed step instead of restarting the workflow from the beginning.

Can be called with DLQ IDs (with optional flowControl and retries), or with a filter object to resume matching entries.

Arguments

DLQ ID mode

dlqId · string|string[] · required

The DLQ entry ID or list of IDs to resume. Use the dlqId field from messages returned by client.dlq.list().

flowControl · object

An optional flow control configuration to limit concurrency and execution rate of resumed workflow runs.

See Flow Control for details.

Show properties

key · string

A logical grouping key that identifies which resumed runs share the same flow control limits.

rate · number

The maximum number of allowed resumption requests per second.

parallelism · number

The maximum number of resumed runs that can execute concurrently.

period · string|number

The time window used to enforce the defined rate limit. Default is 1s.

retries · number

Number of retry attempts to apply when resuming the workflow run. Defaults to 3 if not provided.

Filter mode

label · string

Resume DLQ entries with this label.

workflowUrl · string

Resume DLQ entries matching this workflow URL.

workflowRunIds · string[]

Resume DLQ entries matching these workflow run IDs.

fromDate · string

Resume DLQ entries created after this date (Unix ms as string).

toDate · string

Resume DLQ entries created before this date (Unix ms as string).

Response

The return type depends on the input:

• Single DLQ ID (string): Returns a single object
• Array of DLQ IDs: Returns an array of objects
• Filter mode: Returns an array of objects

workflowRunId · string

The ID of the workflow run resumed from the DLQ message.

workflowCreatedAt · string

The timestamp when the resumed run was created.

Usage

Single

const { messages } = await client.dlq.list();

const run = await client.dlq.resume({
  dlqId: messages[0].dlqId,
  flowControl: {
    key: "my-flow-control-key",
    parallelism: 10,
  },
  retries: 3,
});

console.log(run.workflowRunId); // ID of the resumed workflow run