Dify Octri Demo
GET/workflow/{workflow_run_id}/events

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.

4 parameters
workflow_run_idstringrequired
Workflow run ID whose event stream to resume, from the response or streaming events of [Run Workflow](/en/api-reference/workflow-runs/run-workflow).
userstringrequired
End-user identifier, defined by your app and unique within it. Must match the `user` that started the run. See [End User Identity](/en/api-reference/guides/end-user-identity).
include_state_snapshotbooleanoptional
When `true`, replay from the persisted state snapshot to include a status summary of already-executed nodes before streaming new events.
Default:false
continue_on_pausebooleanoptional
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.
Default:false

3 status codes
200Server-Sent Events stream. It opens with a bare `event: ping` frame (keep-alive; more arrive roughly every 10 seconds); every other event is delivered as `data: {JSON}\n\n`. Event payloads follow the same schemas as the original streaming response.
400`not_workflow_app` : Please check if your app mode matches the right API route.

One documented failure

  • not_workflow_app

    Please check if your app mode matches the right API route.

    not_workflow_app

404`not_found` : Workflow run not found.

One documented failure

  • not_found

    Workflow run not found

    not_found

Error handling

A 400 is returned: not_workflow_app : Please check if your app mode matches the right API route. A 404 is returned: not_found : Workflow run not found.