Skip to main content
GET
/
whatsapp_configs
/
{whatsapp_config_id}
/
whatsapp_webhooks
List WhatsApp webhooks
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "9e8d7c6b-5a4f-3e2d-1c0b-9a8f7e6d5c4b",
      "url": "https://example.com/webhook",
      "secret_key": "your-secret-key",
      "events": [
        "whatsapp.message.received",
        "whatsapp.message.sent"
      ],
      "active": true,
      "headers": {
        "X-Custom-Header": "custom-value"
      },
      "buffer_enabled": false,
      "buffer_window_seconds": 5,
      "max_buffer_size": 50,
      "buffer_events": [
        "whatsapp.message.received"
      ],
      "inactivity_minutes": 60,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

Authorizations

​
X-API-Key
string
header
required

Your project API key

Path Parameters

​
whatsapp_config_id
string<uuid>
required

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:20
Required range: 1 <= x <= 100
​
q[url_cont]
string

Filter webhooks by URL (contains)

​
q[active_eq]
boolean

Filter webhooks by active status

Response

A list of WhatsApp webhooks

​
data
object[]
​
meta
object
⌘I