Get WhatsApp config health status

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

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

WhatsApp Configs

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

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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

Your project API key

Path Parameters

whatsapp_config_id

string

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

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

Customers

WhatsApp Display Names

Setup Links

WhatsApp Webhooks

WhatsApp Configs

WhatsApp Broadcasts

Get WhatsApp config health status

Authorizations

Path Parameters

Response