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.

Arguments

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.

Response

client.dlq.resume() returns one or more objects with details of the resumed workflow run(s):

workflowRuns · object[]

Hide child attributes

workflowRunId · string

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

workflowCreatedAt · number

The Unix timestamp (in milliseconds) when the resumed run was created.

Usage

Single

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

const response = await client.dlq.resume({
  dlqId: messages[0].dlqId, // Use the dlqId from the message
  flowControl: {
    key: "my-flow-control-key",
    value: "my-flow-control-value",
  },
  retries: 3,
});