DLQ

List Failed Workflow Runs

Changed on

List and paginate through all failed workflow runs currently in the DLQ.

Failed workflows end up in the DLQ after exhausting all retry attempts. You can filter, paginate, and inspect these failures to understand what went wrong and decide whether to resume, restart, or delete them.

get/v2/workflows/dlq

Request

Query parameters

cursorstring

Pagination cursor. If provided, returns the next page of results.

countinteger

The maximum number of failed workflow runs to return per page.

fromDateinteger

Filter by starting date in milliseconds (Unix timestamp). This is inclusive.

toDateinteger

Filter by ending date in milliseconds (Unix timestamp). This is inclusive.

workflowUrlstring[]

Filter by workflow URL. Supports multiple values.

workflowRunIdstring

Filter by workflow run ID.

workflowCreatedAtinteger

Filter by workflow creation timestamp in milliseconds (Unix timestamp).

labelstring[]

Filter by label assigned to the workflow run. Supports multiple values. You can pass multiple values to match workflow runs with any of the given labels (OR logic).

Examples:

  • label=my_label
  • label=label_1&label=label_2
  • label=label_1,label_2
failureFunctionStatestring[]

Filter by failure function state. Supports multiple values.

StateDescription
CALLBACK_INPROGRESSThe failure function is in progress.
CALLBACK_SUCCESSThe failure function run successfully.
CALLBACK_FAILThe failure function failed to run.
CALLBACK_CANCELEDThe failure function was manually canceled
callerIpstring[]

Filter by IP address of the publisher. Supports multiple values.

flowControlKeystring[]

Filter by Flow Control Key. Supports multiple values.

Response

List of failed workflow runs

cursorstring

Pagination cursor for the next page. Empty if no more results.

Changes

    • info

      for the query request parameter callerIp, the type was generalized from string to array

    • info

      for the query request parameter failureFunctionState, the type was generalized from string to array

    • info

      for the query request parameter flowControlKey, the type was generalized from string to array

    • info

      for the query request parameter workflowUrl, the type was generalized from string to array

    • info

      for the query request parameter label, the type was generalized from string to array

    • info

      added the optional property // to the response with the status

    • info

      response property messages/items/label deprecated