WebSocket API
Real-time event streaming via WebSocket for worker updates and workflow events.
WebSocket API
Steadybase provides a WebSocket server for real-time event streaming. Connected clients receive live updates for worker status changes, workflow progress, and task broadcasts.
Connection
For local development:
Authentication
WebSocket connections require a valid JWT token:
:::warning Unauthenticated WebSocket connections are rejected immediately. :::
Event Types
Worker Status Update
Sent when a worker's status changes (e.g., started, waiting, stopped):
Workflow Progress
Sent when a workflow step completes or changes:
Drew Coordinator Update
Sent during Drew Coordinator execution as each step progresses:
Task Status Broadcast
Sent when task status is updated (from POST /api/tasks/status):
Approval Request
Sent when a workflow reaches a human approval gate:
Client Example
Reconnection
The server does not implement heartbeats. Clients should implement their own reconnection logic: