List webhooks - Kapso Documentation

GET

phone_numbers

{phone_number_id}

webhooks

List webhooks

curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/phone_numbers/{phone_number_id}/webhooks \
  --header 'X-API-Key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "kind": "kapso",
      "events": [
        "<string>"
      ],
      "active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone_number_id": "<string>",
      "secret_key": "<string>",
      "headers": {},
      "buffer_enabled": true,
      "buffer_window_seconds": 123,
      "max_buffer_size": 123,
      "buffer_events": [
        "<string>"
      ],
      "inactivity_minutes": 123,
      "payload_version": "<string>"
    }
  ],
  "meta": {
    "page": 2,
    "per_page": 2,
    "total_pages": 1,
    "total_count": 1
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

phone_number_id

string

required

Query Parameters

url_contains

string

Filter by URL substring

kind

enum<string>

Filter by webhook kind

Available options:

kapso,

meta

active

boolean

Filter by active status

created_after

string<date-time>

created_before

string<date-time>

per_page

integer

Required range: x >= 1

page

integer

Required range: x >= 1

Response

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

Create webhookSubscribe to WhatsApp events for this number. Two webhook types available: - **kapso**: Event-based webhooks with filtered events, buffering support, and Kapso payload format - **meta**: Raw Meta webhook forwarding - receives the exact payload Meta sends, with X-Idempotency-Key header Use buffering (kapso only) to batch high-volume events like inbound messages. Without buffering, each message triggers an immediate webhook delivery.

List webhooks

curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/phone_numbers/{phone_number_id}/webhooks \
  --header 'X-API-Key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "kind": "kapso",
      "events": [
        "<string>"
      ],
      "active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone_number_id": "<string>",
      "secret_key": "<string>",
      "headers": {},
      "buffer_enabled": true,
      "buffer_window_seconds": 123,
      "max_buffer_size": 123,
      "buffer_events": [
        "<string>"
      ],
      "inactivity_minutes": 123,
      "payload_version": "<string>"
    }
  ],
  "meta": {
    "page": 2,
    "per_page": 2,
    "total_pages": 1,
    "total_count": 1
  }
}