Listen to Workflow Execution (SSE)

curl --request GET \
  --url https://app.splox.io/api/v1/workflow-requests/{id}/listen \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.splox.io/api/v1/workflow-requests/{id}/listen', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.splox.io/api/v1/workflow-requests/{id}/listen",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.splox.io/api/v1/workflow-requests/{id}/listen"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.splox.io/api/v1/workflow-requests/{id}/listen")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "workflow_request": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entry_node_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billing_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_node_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_workflow_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chat_id": "<string>",
    "payload": {},
    "metadata": {},
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "node_execution": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input_data": {},
    "output_data": {},
    "attempt_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z"
  }
}

GET

workflow-requests

{id}

listen

Listen to Workflow Execution (SSE)

curl --request GET \
  --url https://app.splox.io/api/v1/workflow-requests/{id}/listen \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.splox.io/api/v1/workflow-requests/{id}/listen', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.splox.io/api/v1/workflow-requests/{id}/listen",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.splox.io/api/v1/workflow-requests/{id}/listen"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.splox.io/api/v1/workflow-requests/{id}/listen")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "workflow_request": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entry_node_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billing_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_node_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_workflow_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chat_id": "<string>",
    "payload": {},
    "metadata": {},
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "node_execution": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input_data": {},
    "output_data": {},
    "attempt_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z"
  }
}

Streams real-time execution updates via Server-Sent Events (SSE) as the workflow runs.

Usage

curl -N -H "Authorization: Bearer YOUR_TOKEN" \
  https://app.splox.io/api/v1/workflow-requests/{workflow_request_id}/listen

from splox import SploxClient

client = SploxClient(api_key="YOUR_API_KEY")

for event in client.workflows.listen("WORKFLOW_REQUEST_ID"):
    if event.is_keepalive:
        continue
    if event.node_execution:
        ne = event.node_execution
        print(f"[{ne.status}] Node {ne.node_id}")
    if event.workflow_request:
        wr = event.workflow_request
        if wr.status in ("completed", "failed", "stopped"):
            print(f"Workflow {wr.status}")
            break

import Splox from "splox";

const client = new Splox("YOUR_API_KEY");

const stream = await client.workflows.listen("WORKFLOW_REQUEST_ID");
for await (const event of stream) {
  if (event.isKeepalive) continue;
  if (event.node_execution) {
    console.log(`[${event.node_execution.status}] Node ${event.node_execution.node_id}`);
  }
  if (event.workflow_request) {
    const status = event.workflow_request.status;
    if (["completed", "failed", "stopped"].includes(status)) {
      console.log(`Workflow ${status}`);
      break;
    }
  }
}

client := splox.NewClient("YOUR_API_KEY")

iter, err := client.Workflows.Listen(ctx, "WORKFLOW_REQUEST_ID")
if err != nil {
    log.Fatal(err)
}
defer iter.Close()

for iter.Next() {
    ev := iter.Event()
    if ev.IsKeepalive {
        continue
    }
    if ev.NodeExecution != nil {
        fmt.Printf("[%s] Node %s\n", ev.NodeExecution.Status, ev.NodeExecution.NodeID)
    }
    if ev.WorkflowRequest != nil {
        switch ev.WorkflowRequest.Status {
        case "completed", "failed", "stopped":
            fmt.Printf("Workflow %s\n", ev.WorkflowRequest.Status)
            return
        }
    }
}

How It Works

On connection, all existing node executions are sent immediately
Then the stream subscribes to real-time updates via Redis PubSub
Each event contains a workflow_request and/or node_execution update
Keepalive messages (data: keepalive) are sent every 3 seconds
The stream closes when the workflow completes, fails, or stops

Response Format

Standard SSE format — each event is a data: line followed by two newlines:

data: {"workflow_request":{...},"node_execution":{...}}

data: keepalive

data: {"workflow_request":{"id":"...","status":"completed",...}}

Each event payload contains:

{
  "workflow_request": {
    "id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8",
    "status": "in_progress",
    "workflow_version_id": "0199e001-a23b-7c8d-1234-567890abcdef"
  },
  "node_execution": {
    "id": "0199f124-e70f-8gge-2242-5dd6bc151ff9",
    "node_id": "0199e002-b34c-8d9e-2345-678901bcdef0",
    "status": "completed",
    "output_data": { "text": "Here is the result..." }
  }
}

Status Values

Workflow Request:

pending — Request received, waiting to start
in_progress — Currently executing
waiting — Paused, waiting for input (e.g., tool approval)
completed — Finished successfully
failed — Execution failed
stopped — Manually stopped

Node Execution:

pending — Queued
in_progress — Currently executing
completed — Finished successfully
failed — Execution failed
blocked — Waiting for dependencies
skipped — Skipped (conditional branch not taken)
stopped — Manually stopped
waiting — Paused, waiting for input

Notes

Authentication required: Include Bearer token in Authorization header.

Connection timeout: SSE connections timeout after 30 minutes. Reconnect if needed.

Authorizations

Authorization

string

header

required

API token generated from your Splox account settings. Create tokens at https://app.splox.io/account?tab=settings

Path Parameters

string<uuid>

required

Workflow request ID

Response

200 - text/event-stream

SSE stream of execution events. Each event contains a workflow_request and/or node_execution update. Keepalive messages sent every 3 seconds. Connection times out after 30 minutes.

workflow_request

object

Represents a workflow execution request

Show child attributes

node_execution

object

Represents the execution state of a single node

Show child attributes

Getting Started

Workflows

Workflow Execution

MCP

Chats

Memory

Events

Billing

Listen to Workflow Execution (SSE)

Usage

How It Works

Response Format

Status Values

Notes

Authorizations

Path Parameters

Response

​Usage

​How It Works

​Response Format

​Status Values

​Notes

Authorizations

Path Parameters

Response

Usage

How It Works

Response Format

Status Values

Notes