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>'

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

fetch('https://app.kapso.ai/api/v1/whatsapp_configs/{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/{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/{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/{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": {},
      "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>"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

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

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

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

fetch('https://app.kapso.ai/api/v1/whatsapp_configs/{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/{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/{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/{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": {},
      "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>"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

Authorizations

X-API-Key

string

header

required

API key required for all endpoints

Path Parameters

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

Show child attributes

timestamp

string<date-time>

When the health check was performed

error

string

Error message if overall health check failed

Guides

WhatsApp Conversations

WhatsApp Messages

Conversation Assignments

WhatsApp Templates

WhatsApp Contacts

WhatsApp Contact Notes

WhatsApp Configs

WhatsApp Calls

WhatsApp Contact Call Permissions

Get WhatsApp config health status

Authorizations

Path Parameters

Response