Skip to main content
The Intention WebSocket API uses heartbeats to detect dead connections, signal block boundaries, and let clients verify that they are not silently disconnected from the stream. This page will document the heartbeat protocol — message format, cadence, and what a client should do when a heartbeat is missed.
Status: not yet published. The heartbeat protocol will be released alongside the public testnet. Until then, treat the descriptions below as planning documentation.

What this page will contain

When the API ships, this page will document:
  • Heartbeat cadence. The fixed interval at which the server emits heartbeat messages on every active connection.
  • Block-boundary heartbeats. Distinct heartbeat messages that mark the start of a new committed block, including block hash and height. Useful for clients aligning their local view with consensus.
  • Client liveness. Whether the client is required to send pings, and the timeout after which the server will close an idle connection.
  • Reconnection. Recommended reconnection logic, including exponential backoff and resubscription, cross-referenced with subscriptions.
  • Errors. How dropped heartbeats are surfaced and how they interact with errors.
For early integration questions, email contact@intention.xyz.