ConverterHQDevelopers
Documentation

Realtime events

WebSockets and resumable SSE for live Job and Task progress.

Realtime APIs project the same canonical lifecycle events used by webhooks. They are optimized for live interfaces rather than durable automation.

WebSockets

Obtain a short-lived realtime token and connect to wss://events.converterhq.io/v1. Subscribe to account, Job or Task channels after ownership authorization. Tokens should be minted close to connection time and never treated as long-lived API credentials.

Server-Sent Events

Use bounded SSE streams when EventSource/curl simplicity is preferable. Reconnect with Last-Event-ID to resume within the retained event window.

Reconnect safely

Assume a realtime connection can disappear at any time. Back off reconnect attempts with jitter, resume where supported, then read the canonical Job or Task over REST to close any event gap before updating durable application state.

Delivery guarantees