Skip to main content
WEBHOOK
heartbeat-received
{
  "event": "phone.heartbeat.received",
  "data": {
    "id": "9e06e75d-416d-454c-a80c-2ea11e04563b",
    "phone_id": "9defcf1e-552c-4bef-a843-872edec576ef",
    "battery_level": "63",
    "is_charging": false,
    "local_timestamp": "2025-01-22 07:48:05",
    "app_version": "v1.0.3",
    "created_at": "2025-01-22 05:48:06",
    "updated_at": "2025-01-22 05:48:06"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt

Use this file to discover all available pages before exploring further.

This webhook is triggered when the heartbeat is received either by manually clicking the send heartbeats button on the android app or automatically every 15 minutes.

Headers

​
x-userId
string
required

User UUID associated with the connected WhatsApp instance.

​
x-instanceId
string
required

Instance UUID of the connected WhatsApp instance.

Body

application/json
​
event
enum<string>
required
Available options:
phone.heartbeat.received
​
data
object
required

Response

200

Successfully received the heartbeat. The server acknowledged.