Skip to main content
GET
/
api
/
events
/
stream
GET /api/events/stream
curl --request GET \
  --url https://sluice.sh/api/api/events/stream

Documentation Index

Fetch the complete documentation index at: https://docs.sluice.sh/llms.txt

Use this file to discover all available pages before exploring further.

Opens a persistent SSE connection that streams real-time updates for a specific connection. The dashboard uses this endpoint to provide live updates without polling.

​
Authentication

Session cookie (dashboard).
The SSE endpoint authenticates via session cookies only — it cannot be consumed by external scripts or tools that don’t share the browser session. API key authentication for all endpoints, including SSE, is planned for V1.

​
Query parameters

ParameterTypeRequiredDescription
connectionIdstringYesUUID of the connection to stream events for.
typesstringNoComma-separated event types to filter (e.g., job,worker,queue). If omitted, all event types are streamed.

​
Event format

Events follow the SSE specification: 
event: job:state_change
data: {"id":"a1b2c3d4...","name":"app.tasks.send_email","state":"completed","previousState":"active","timestamp":"2026-02-27T10:30:00.000Z"}

event: worker:heartbeat
data: {"id":"d4e5f6a7...","hostname":"celery@worker-1","state":"online","activeJobs":3}

event: queue:snapshot
data: {"name":"default","depth":42,"consumers":4}

event: heartbeat
data: {"timestamp":"2026-02-27T10:30:15.000Z"}

​
Event types

EventDescription
job:state_changeA job’s state changed (new job, started, completed, failed, etc.).
worker:heartbeatA worker sent a heartbeat with its current status.
worker:state_changeA worker came online or went offline.
queue:snapshotUpdated queue depth and consumer count.
heartbeatKeep-alive event sent every 15 seconds.

​
Connection handling

  • The SSE connection stays open indefinitely until the client disconnects.
  • A heartbeat event is sent every 15 seconds to keep the connection alive through proxies and load balancers.
  • If the connection drops, reconnect with the same URL. The browser’s EventSource API handles reconnection automatically.

​
Example (JavaScript)

const eventSource = new EventSource(
  "/api/events/stream?connectionId=550e8400-e29b-41d4-a716-446655440000"
);

eventSource.addEventListener("job:state_change", (event) => {
  const job = JSON.parse(event.data);
  console.log(`Job ${job.name} → ${job.state}`);
});

eventSource.addEventListener("worker:heartbeat", (event) => {
  const worker = JSON.parse(event.data);
  console.log(`Worker ${worker.hostname}: ${worker.activeJobs} active jobs`);
});

eventSource.onerror = () => {
  console.log("SSE connection lost, reconnecting...");
};