Skip to content

js-bao-wss-client


js-bao-wss-client / WorkflowStartedEvent

Interface: WorkflowStartedEvent ​

Payload of the workflowStarted event (client.on("workflowStarted", ...)). Delivered in real time when a workflow run started by this user begins executing. Pair with the workflowStatus event to observe the run's completion.

Properties ​

contextDocId? ​

optional contextDocId?: string


instanceId ​

instanceId: string


meta? ​

optional meta?: Record<string, unknown>


runId ​

runId: string


runKey ​

runKey: string


type ​

type: "workflowStarted"


workflowId ​

workflowId: string


workflowKey ​

workflowKey: string

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30