client.logs

The logs method retrieves workflow run logs using the List Workflow Runs API.

Arguments

workflowRunId · string

Filter by a specific workflow run ID.

count · number

Maximum number of runs to return. Defaults to a system-defined value if not specified.

state · string

Filter workflow runs by execution state.

State	Description
RUN_STARTED	The workflow run is in progress.
RUN_SUCCESS	The workflow run completed successfully.
RUN_FAILED	The run failed after all retries.
RUN_CANCELED	The run was manually canceled.

workflowUrl · string

Filter by the exact workflow URL.

label · string

Filter by workflow label.

workflowCreatedAt · number

Filter by the workflow creation time (Unix timestamp).

cursor · string

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

Response

cursor · string

A cursor to use for pagination. If no cursor is returned, there are no more workflow runs.

runs · Array

Show child attributes

workflowRunId · string

The ID of the workflow run.

workflowUrl · string

The URL address of the workflow endpoint.

workflowState · string

The current state of the workflow run at this point in time

Value	Description
RUN_STARTED	The workflow has started to run and currently in progress.
RUN_SUCCESS	The workflow run has completed succesfully.
RUN_FAILED	Some errors has occured and workflow failed after all retries.
RUN_CANCELED	The workflow run has canceled upon user request.

workflowCreatedAt · number

The Unix timestamp (in milliseconds) when the workflow run started.

workflowRunCompletedAt · string

The Unix timestamp (in milliseconds) when the workflow run was completed, if applicable.

label · string

The label of the run assigned by the user on trigger.

failureFunction · FailureFunction

The details of the failure callback message, if a failure function was defined for the workflow.

Show child attributes

messageId · string

The ID of the failure callback message

url · string

The URL address of the failure function

state · string

The state of the failure callback

Value
CALLBACK_INPROGRESS
CALLBACK_SUCCESS
CALLBACK_FAIL

failHeaders · string

The HTTP headers of the message that triggered the failure function.

failStatus · string

The HTTP response status of the message that triggered the failure function.

failResponse · string

The response body of the message that triggered the failure function.

dlqId · string

The DLQ ID of the workflow run.

responseBody · string

Response body of the failure function/url. When failure function is used, this contains the returned message from the failure function.

responseHeaders · array

Reponse headers of the failure function/url. This is valuable when the call to run the failure function/url is rejected because of a platform limit.

responseStatus · int

Reponse status of the failure function/url. This is valuable when the call to run the failure function/url is rejected because of a platform limit.

errors · array

A call to failure url/function can be retried as maxRetries time. This array contains errors of all retry attempts.

Show child attributes

status · int

Response status of the endpoint that caused the error

headers · array

Response Headers of the endpoint that caused the error

body · string

Response Body of the endpoint that caused the error if available

error · string

An error message that happened before/after calling the user's endpoint.

time · int64

The time of the error happened in Unix time milliseconds

maxRetries · string

Max number of retries configured when seeing an error.

steps · Array

Hide child attributes

type · string

The type of grouped steps

Value	Description
sequential	Indicates only one step is excuted sequentially
parallel	Indicates multiple steps being executed in parallel.
next	Indicates there is information about currently executing step(s)

steps · Array

Show child attributes

stepId · number

The ID of the step which increases monotonically.

stepName · string

The name of the step. It is specified in workflow by user.

stepType · string

Execution type of the step which indicates type of the context function.

Value	Function
Initial	The default step which created automatically
Run	context.run()
Call	context.call()
SleepFor	context.sleepFor()
SleepUntil	context.sleepUntil()
Wait	context.waitForEvent()
Notify	context.notify()
Invoke	context.invoke()

messageId · string

The ID of the message associated with this step.

out · string

The output returned by the step

concurrent · string

The total number of concurrent steps that is running alongside this step

state · string

The state of this step at this point in time

Value
STEP_SUCCESS
STEP_RETRY
STEP_FAILED
STEP_CANCELED

createdAt · string

The unix timestamp in milliseconds when the message associated with this step has created.

nextDeliveryTime · number

The unix timestamp in milliseconds when this step will be retried. This is set only when the step state is STEP_RETRY

The following fields are set only when a specific type of step is executing. These fields are not available for all step types.

sleepFor · string

The duration in milliseconds which step will sleep. Only set if stepType is SleepFor.

sleepUntil · string

The unix timestamp (in milliseconds) which step will sleep until. Only set if stepType is SleepUntil.

waitEventId · string

The event id of the wait step. Only set if stepType is Wait.

waitTimeoutDeadline · string

The unix timestamp (in milliseconds) when the wait will time out.

waitTimeoutDuration · string

The duration of timeout in human readable format (e.g. 120s, 1m, 1h).

waitTimeout · string

Set to true if this step is cause of a wait timeout rather than notifying the waiter.

callUrl · string

The URL of the external address. Available only if stepType is Call.

callMethod · string

The HTTP method of the request sent to the external address. Available only if stepType is Call.

callHeaders · string

The HTTP headers of the request sent to the external address. Available only if stepType is Call.

callBody · string

The body of the request sent to the external address. Available only if stepType is Call.

callResponseStatus · number

The HTTP status returned by the external call. Available only if stepType is Call.

callResponseBody · string

The body returned by the external call. Available only if stepType is Call.

callResponseHeaders · array

The HTTP headers returned by the external call. Available only if stepType is Call.

invokedWorkflowRunId · string

The ID of the invoked workflow run if this step is an invoke step.

invokedWorkflowUrl · string

The URL address of the workflow server of invoked workflow run if this step is an invoke step.

invokedWorkflowCreatedAt · number

The Unix timestamp (in milliseconds) when the invoked workflow was started if this step is an invoke step.

invokedWorkflowRunBody · string

The body passed to the invoked workflow if this step is an invoke step.

invokedWorkflowRunHeaders · string

The HTTP headers passed to invoked workflow if this step is an invoke step.

---

Usage

import { Client } from "@upstash/workflow";

const client = new Client({ token: "<QSTASH_TOKEN>" })
const { runs, cursor } = await client.logs({})