Create a WhatsApp webhook

Creates a new webhook for receiving WhatsApp events for this configuration

POST /whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks

cURL

basic_webhook

curl --request POST \
  --url https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "whatsapp_webhook": {
    "url": "https://example.com/webhook",
    "secret_key": "my-secret-key",
    "events": [
      "whatsapp.message.received",
      "whatsapp.message.sent"
    ],
    "active": true
  }
}
'

201

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

{
  "error": "Resource not found"
}

{
  "error": "Resource not found"
}

{
  "error": "Resource not found"
}

Authorizations

X-API-Key · string · header · required

Your project API key

Path Parameters

whatsapp_config_id · string<uuid> · required

Body

application/json

whatsapp_webhook · object · required

Show child attributes

Response

201

application/json

Webhook created successfully

data · object

Show child attributes