workflow-executions
List Workflow Execution Event History
Get a workflow execution.
GET
/
workflow-executions
/
{execution_id}
/
history
Authorizations
Path Parameters
Query Parameters
Response
200 - application/json
The event types we care about.
Available options:
WORKFLOW_EXECUTION_STARTED
, WORKFLOW_EXECUTION_COMPLETED
, WORKFLOW_EXECUTION_FAILED
, WORKFLOW_EXECUTION_TERMINATED
, WORKFLOW_EXECUTION_CANCELED
, ACTIVITY_TASK_SCHEDULED
, ACTIVITY_TASK_STARTED
, ACTIVITY_TASK_COMPLETED
, ACTIVITY_TASK_FAILED
, CHILD_WORKFLOW_EXECUTION_STARTED
, CHILD_WORKFLOW_EXECUTION_COMPLETED
, CHILD_WORKFLOW_EXECUTION_FAILED
, START_CHILD_WORKFLOW_EXECUTION_INITIATED
The action group of the event. We use this to keep track of what events are related to each other.
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.