Skip to main content
POST
heartbeat-received
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.