Quote
WebSocket Heartbeat Event
WebSocket Event: heartbeat
Periodic heartbeat events sent by the server to keep the connection alive and verify connectivity.
Event Details:
- Event Name:
heartbeat - Direction: Server → Client
- Frequency: Every 10 seconds
- Purpose: Connection keep-alive and health check
Response Structure: The heartbeat event contains a Unix timestamp indicating when the heartbeat was sent.
Use Cases:
- Monitor connection health
- Detect connection drops
- Implement reconnection logic if heartbeats stop
GET
WebSocket Heartbeat Event
Response
200 - application/json
Example heartbeat event payload
Unix timestamp
Previous
WebSocket Disconnect Event**WebSocket Event: `disconnect`**
Manually disconnect from the WebSocket server. This cleans up server-side resources associated with your connection.
**Event Details:**
- **Event Name:** `disconnect`
- **Direction:** Client → Server
- **Purpose:** Graceful disconnection and cleanup
**Use Cases:**
- Clean disconnection when closing your application
- Freeing server resources
- Proper connection lifecycle management
Next
WebSocket Heartbeat Event