Skip to main content
GET
Stream run control events

Authorizations

Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Headers

Last-Event-ID
string

Path Parameters

id
string<uuid>
required

Query Parameters

params
object
required

Response

Server-sent persist control events

Run control event

id
string<uuid>
required

Event identifier

organizationId
integer<int32>
required

Organization this event belongs to

runId
string<uuid>
required

Run this event belongs to

seq
integer<int64>
required

Supervisor-monotonic sequence, starts at 1

type
enum<string>
required

Control event type

Available options:
phase,
headline,
case_started,
case_finished,
step_started,
step_finished,
artifact_ready,
artifact_lifecycle,
finished,
stream_gap
payload
object
required

Small typed payload for this event

createdAt
string<date-time>
required

When the event was persisted

caseId
string<uuid> | null

Case this event refers to

stepId
string<uuid> | null

Step this event refers to

artifactId
string<uuid> | null

Artifact this event refers to