Stream Workflow Events
Available for: Chatflow, Workflow apps.
Resume the Server-Sent Events stream for a workflow run after a pause or a dropped SSE connection. For runs that have already finished, the stream emits a single workflow_finished event and closes.
To check an in-progress run’s node-level status and progress, call it with include_state_snapshot=true: the stream replays each already-executed node’s status before streaming new events.
Authorizations
Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).
Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).
Path Parameters
Workflow run ID whose event stream to resume, from the response or streaming events of Run Workflow.
Query Parameters
End-user identifier, defined by your app and unique within it. Must match the user that started the run. See End User Identity.
When true, replay from the persisted state snapshot to include a status summary of already-executed nodes before streaming new events.
Set to true to keep the stream open across multiple workflow_paused events (useful when the workflow has more than one Human Input node in sequence). Default closes the stream after the first pause.
Response
Server-Sent Events stream. Each event is delivered as data: {JSON}\n\n. Event payloads follow the same schemas as the original streaming response.
SSE stream of events from a resumed workflow run, in the same format as Run Workflow (Workflow apps) or Send Chat Message (Chatflow apps).