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/{whatsapp_config_id}/health

Get WhatsApp config health status

cURL

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

200

healthy_config

{
  "status": "healthy",
  "checks": {
    "phone_number_access": {
      "passed": true,
      "details": {
        "verified_name": "My Business",
        "display_phone_number": "[phone]",
        "quality_rating": "GREEN",
        "id": "123456789012345"
      }
    },
    "messaging_health": {
      "passed": true,
      "overall_status": "AVAILABLE",
      "details": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "123456789012345",
            "can_send_message": "AVAILABLE"
          },
          {
            "entity_type": "WABA",
            "id": "987654321098765",
            "can_send_message": "AVAILABLE"
          },
          {
            "entity_type": "BUSINESS",
            "id": "456789012345678",
            "can_send_message": "AVAILABLE"
          },
          {
            "entity_type": "APP",
            "id": "789012345678901",
            "can_send_message": "AVAILABLE"
          }
        ]
      }
    },
    "webhook_subscription": {
      "passed": true,
      "details": {
        "app_id": 789012345678901,
        "subscribed": true,
        "subscribed_fields": null
      }
    },
    "webhook_verified": {
      "passed": true,
      "details": {
        "verified_at": "2024-01-15T10:30:00.000Z",
        "message": "Webhook successfully verified at 2024-01-15 10:30:00 UTC"
      }
    }
  },
  "timestamp": "2024-01-20T14:25:30Z"
}

Authorizations

X-API-Key · string · header · required

Your project API key

Path Parameters

whatsapp_config_id · string · 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

Example:

"healthy"

checks · object

Individual health check results

Show child attributes

timestamp · string<date-time>

When the health check was performed

Example:

"2024-01-20T10:00:00Z"

error · string

Error message if overall health check failed