Webhooks

Create project webhook

Create 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.

Subscribing to project.event requires project events to be available on your plan.

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)

POST

webhooks

curl --request POST \
  --url https://api.kapso.ai/platform/v1/whatsapp/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "whatsapp_webhook": {
    "url": "https://api.acme.com/webhooks/whatsapp",
    "secret_key": "wh_sec_3kfj9dmfkg8s2",
    "events": [
      "whatsapp.phone_number.created",
      "whatsapp.phone_number.deleted"
    ]
  }
}
'

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

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-Key

string

header

required

Body

application/json

whatsapp_webhook

object

required

Show child attributes

Response

Created

data

object

required

Show child attributes

Get project webhook

curl --request POST \
  --url https://api.kapso.ai/platform/v1/whatsapp/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "whatsapp_webhook": {
    "url": "https://api.acme.com/webhooks/whatsapp",
    "secret_key": "wh_sec_3kfj9dmfkg8s2",
    "events": [
      "whatsapp.phone_number.created",
      "whatsapp.phone_number.deleted"
    ]
  }
}
'

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

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Getting started

Connect

Operate

Extend

API Reference

Customers

Setup Links

Webhooks

Phone Numbers

Broadcasts

Messages

Conversations

Display Names

Media

Contacts

Users

Webhook Deliveries

Events

API Logs

Log Search

Provider Models

Inbox Embeds

WhatsApp Flows

Create project webhook

Authorizations

Body

Response