Get WhatsApp config health status

Performs a comprehensive health check on a WhatsApp configuration to verify its operational status.

Health Checks Performed:

• Phone number access verification
• Messaging health status (ability to send messages)
• Webhook subscription status
• Webhook verification status

Response Status:

• healthy: All checks pass
• degraded: Some non-critical checks fail (e.g., webhook issues)
• unhealthy: Critical checks fail (e.g., phone number access, token validity)
• error: Service error occurred during health check

Note: Test message sending is disabled by default for performance reasons.

GET /whatsapp_configs/{id}/health

Get WhatsApp config health status

cURL

curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_configs/{id}/health \
  --header 'X-API-Key: <api-key>'

200

{
  "checks": {
    "phone_number_access": {
      "passed": true,
      "details": {},
      "error": "<string>"
    },
    "messaging_health": {
      "passed": true,
      "overall_status": "<string>",
      "details": {}
    },
    "webhook_subscription": {
      "passed": true,
      "details": {},
      "error": "<string>"
    },
    "webhook_verified": {
      "passed": true,
      "details": {}
    }
  },
  "timestamp": "2023-11-07T05:31:56Z",
  "error": "<string>"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Path Parameters

id · string<uuid> · required

ID of the WhatsApp configuration to check

Response

200

application/json

Health check completed successfully

status · enum<string>

Overall health status

Available options: healthy, degraded, unhealthy, error

checks · object

Individual health check results

Show child attributes

timestamp · string<date-time>

When the health check was performed

error · string

Error message if overall health check failed