Heartbeat Callback

Updated on November 21, 2025

The SDK periodically sends a heartbeat message to the callback URL to confirm that the connection between your server and the SDK is active and stable.

This ensures your system can monitor SDK uptime and detect disconnections proactively.


📩 Sample Payload (from SDK)

{
  "heartbeat": {
    "status": true,
    "time": 1762168548328
  }
}

📘 Glossary of Keys

Key Description
heartbeat Parent object representing the heartbeat signal
status Connection state (true = connected and active, false = disconnected)
time Unix timestamp (in milliseconds) when the heartbeat was sent