v6

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0182128753.1 KB
Workflow Runs

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.

get/workflow/{workflow_run_id}/events

Path parameters

workflow_run_idstring uuid required

Workflow run ID whose event stream to resume, from the response or streaming events of Run Workflow.

Query parameters

userstring required

End-user identifier, defined by your app and unique within it. Must match the user that started the run. See End User Identity.

include_state_snapshotboolean

When true, replay from the persisted state snapshot to include a status summary of already-executed nodes before streaming new events.

continue_on_pauseboolean

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.