githubEdit

clockWorkflowExecutionHistory

WorkflowExecutionHistory Type - Workflow execution with history events

Audience: Programmer

Represents a workflow execution with its complete history events. This type is returned by the workflowHistory query and provides access to all events that occurred during a workflow execution.

This type was introduced to support the separation of execution metadata from history data, enabling better performance when listing workflow executions.

Fields

Field
Type
Description

execution

WorkflowExecution!

The workflow execution identifier containing workflowId and runId

typeName

String!

The name of the workflow type

history

[WorkflowEvent!]!

Complete list of history events for this execution

WorkflowExecution

Field
Type
Description

workflowId

String!

The unique workflow identifier

id

String!

The run ID for this specific execution

WorkflowEvent

Field
Type
Description

eventId

Int!

Sequential event identifier

eventTime

String!

ISO 8601 timestamp when the event occurred

eventType

String!

Type of the event (e.g., WORKFLOW_EXECUTION_STARTED)

extra

Map

Event-specific attributes and details

Service

This type is defined in the Workflow service.

Usage Example

Query Workflow History

Example Response

Notes

  • This type is used exclusively for history retrieval via the workflowHistory query

  • History events are returned in chronological order by eventId

  • The extra field contains event-specific data that varies by event type

  • For execution metadata without history, use WorkflowExecutionInfo via the workflowExecutions query

Last updated

Was this helpful?