Skip to main content

Health

$ curl -X GET https://whatsapp.turn.io/v1/health \
-H 'Authorization: Bearer token'

> {
"health": {
"gateway_status": "connected | connecting | uninitialized | unregistered"
},
"meta": {
"api_status": "stable",
"version": "v2.35.4"
}
}

Check the status of your WhatsApp Business API Client with the health endpoint. This endpoint samples the health of the gateway and sends back a JSON response.

$ curl -X GET https://whatsapp.turn.io/v1/health \
-H 'Authorization: Bearer token'

> {
"health": {
"your-hostname1:your-container-id1": {
"gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
"role": "primary_master | secondary_master | coreapp"
},
"your-hostname2:your-container-id2": {
"gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
"role": "primary_master | secondary_master | coreapp"
}
},
"meta": {
"api_status": "stable",
"version": "v2.35.4"
}
}

In the case of a Multiconnect setup, the response will contain the status and role for each node under a key of its hostname and container ID. See the official documentation at developers.facebook.com for more information about the possible role response values and their meanings.