List WhatsApp webhooks

Returns a list of webhooks configured for a WhatsApp configuration

GET /whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks

List WhatsApp webhooks

cURL

curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_configs/{whatsapp_config_id}/whatsapp_webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

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

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

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

200

application/json

A list of WhatsApp webhooks

data · object[]

Show child attributes

meta · object

Show child attributes