Get Workflow Execution

events

object[]

required

The events in the workflow execution

events.event_id

integer

required

events.event_time

string

required

events.event_type

enum<string>

required

The event types we care about.

Available options:

WORKFLOW_EXECUTION_STARTED,

WORKFLOW_EXECUTION_COMPLETED,

WORKFLOW_EXECUTION_FAILED,

WORKFLOW_EXECUTION_TERMINATED,

WORKFLOW_EXECUTION_CANCELED,

WORKFLOW_EXECUTION_CONTINUED_AS_NEW,

WORKFLOW_EXECUTION_TIMED_OUT,

ACTIVITY_TASK_SCHEDULED,

ACTIVITY_TASK_STARTED,

ACTIVITY_TASK_COMPLETED,

ACTIVITY_TASK_FAILED,

ACTIVITY_TASK_TIMED_OUT,

ACTIVITY_TASK_CANCELED,

CHILD_WORKFLOW_EXECUTION_STARTED,

CHILD_WORKFLOW_EXECUTION_COMPLETED,

CHILD_WORKFLOW_EXECUTION_FAILED,

CHILD_WORKFLOW_EXECUTION_CANCELED,

CHILD_WORKFLOW_EXECUTION_TERMINATED,

START_CHILD_WORKFLOW_EXECUTION_INITIATED,

CHILD_WORKFLOW_EXECUTION_TIMED_OUT

events.task_id

integer

required

events.event_group

object | null

The action group of the event. We use this to keep track of what events are related to each other.

events.event_group.action_input

object

required

This object contains all the information needed to execute an action.

events.event_group.event_id

integer

required

events.event_group.udf_key

string

required

events.event_group.udf_name

string

required

events.event_group.udf_namespace

string

required

events.event_group.action_description

string | null

events.event_group.action_id

string | null

events.event_group.action_ref

string | null

events.event_group.action_result

any | null

events.event_group.action_title

string | null

events.event_group.current_attempt

integer | null

events.event_group.join_strategy

enum<string>

default:

all

Available options:

any,

all

events.event_group.retry_policy

object

events.event_group.start_delay

number

default:

0

events.failure

object | null

events.parent_wf_exec_id

string | null

events.result

any | null

events.role

object | null

The identity and authorization of a user or service.

Params

type : Literal["user", "service"] The type of role. user_id : UUID | None The user's ID, or the service's user_id. This can be None for internal services, or when a user hasn't been set for the role. service_id : str | None = None The service's role name, or None if the role is a user.

User roles

User roles are authenticated via JWT.
The user_id is the user's JWT 'sub' claim.
User roles do not have an associated service_id, this must be None.

Service roles

Service roles are authenticated via API key.
Used for internal services to authenticate with the API.
A service's user_id is the user it's acting on behalf of. This can be None for internal services.

events.workflow_timeout

number | null

history_length

integer

required

Number of events in the history

id

string

required

The ID of the workflow execution

run_id

string

required

The run ID of the workflow execution

start_time

string

required

The start time of the workflow execution

status

enum<string>

required

Available options:

RUNNING,

COMPLETED,

FAILED,

CANCELED,

TERMINATED,

CONTINUED_AS_NEW,

TIMED_OUT

task_queue

string

required

workflow_type

string

required

close_time

string | null

When the workflow was closed if closed.

execution_time

string | null

When this workflow run started or should start.

parent_wf_exec_id

string | null

API Documentation

Get Workflow Execution

Authorizations

Path Parameters

Query Parameters

Response

Params

User roles

Service roles