Health

This document describes the health check component.

GET {{base-url}}/v1/health

HEALTH CHECKParameters

Use the /v1/health endpoint to check the health status of your WhatsApp Business API client. The health endpoint supports Bearer token and API keys authentication.

Name	Description
health (object)	Contains the fields that describe the health of the WhatsApp Business API client.
gateway_status (string)	Status of the connection between the Coreapp and WhatsApp servers.
role (string)	Th role of the container in High Availability/Multiconnect setups. See the Availability and Scaling documentation for more information on these setups. Supported values: primary_master, secondary_master, coreapp

API KEYS

If you wish to monitor the health, metrics, and stats endpoints from an orchestrator, Bearer tokens are not the best option for ongoing checks as they expire every 7 days. To mediate this, you can use an API key, which can be set using the WA_API_KEY environment variable in the waweb environment section in the .yml file of your installation setup.

Note

services:
    ...
    waweb:
    ...
        environment:
        ...
        WA_API_KEY: your-api-key-token

Info

The API key you set must have a minimum of 12 characters and a maximum of 128 characters. The Webapp must be restarted whenever you change the API key.

Contraints

Info

The API key you set must have a minimum of 12 characters and a maximum of 128 characters.