Docs/build/websocket
Beta

WebSocket events

Use authenticated WebSocket events for timely UI updates, then reconcile important state through the authoritative HTTP API.

Current connection boundary

The default Node WebSocket endpoint is /ws. Deployments that route multiple nodes may also use a node-specific path. The gateway authenticates the connection before it joins the node event hub.

Client behavior

  • Use the supported client authentication path and avoid tokens in URLs when a safer protocol or header mechanism is available.
  • Reconnect with bounded backoff and assume a connection gap can lose transient events.
  • Deduplicate persistent notifications and tolerate additive unknown event types.
  • Treat an event as a signal to refresh protected state; do not settle, refund, or complete an order solely from an unverified push payload.
  • Keep route capability and authorization checks even when an event announces a feature or action.

Implementation evidence