List project webhooks - Kapso Documentation

GET

webhooks

List project webhooks

curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/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

Query Parameters

kind

enum<string>

Filter by webhook kind

Available options:

kapso,

meta

page

integer

default:1

Required range: x >= 1

per_page

integer

default:20

Required range: x >= 1

Response

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

Create project webhookCreate a webhook for this project. Two scoping options: - **Project-scoped**: Omit `phone_number_id` to receive project events only - **Number-scoped**: Include `phone_number_id` to receive message and conversation events for that number Project webhooks do not receive message or conversation events. Use a number-scoped webhook (or `POST /whatsapp/phone_numbers/{phone_number_id}/webhooks`) for those. Two webhook types: - **kapso**: Event-based webhooks with filtered events, buffering support, and Kapso payload format - **meta**: Raw Meta webhook forwarding - receives the exact payload Meta sends (requires `phone_number_id`)

List project webhooks

curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/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
  }
}