Skip to main content
GET
/
whatsapp_configs
/
{id}
/
health
Get WhatsApp config health status
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_configs/{id}/health \
  --header 'X-API-Key: <api-key>'
{
  "status": "healthy",
  "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

Health check completed successfully

status
enum<string>

Overall health status

Available options:
healthy,
degraded,
unhealthy,
error
checks
object

Individual health check results

timestamp
string<date-time>

When the health check was performed

error
string

Error message if overall health check failed