GET
/
whatsapp_configs
/
{config_id}
/
health
Get WhatsApp config health status
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_configs/{config_id}/health \
  --header 'X-API-Key: <api-key>'
{
  "status": "healthy",
  "checks": {
    "phone_number_access": {
      "passed": true,
      "details": {
        "verified_name": "My Business",
        "display_phone_number": "+1 555-123-4567",
        "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

API key required for all endpoints

Path Parameters

​
config_id
string
required

ID of the WhatsApp configuration to check

Response

200
application/json

Health check completed successfully

The response is of type object.