Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
webhooks
Get Webhooks
curl --request GET \
  --url https://api.example.com/v1/businesses/{businessId}/webhooks
import requests

url = "https://api.example.com/v1/businesses/{businessId}/webhooks"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v1/businesses/{businessId}/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://api.example.com/v1/businesses/{businessId}/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/v1/businesses/{businessId}/webhooks"

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v1/businesses/{businessId}/webhooks")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/businesses/{businessId}/webhooks")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
Retrieve all webhook registrations currently configured for your business. Use the returned id values when updating or deleting a specific registration.

Endpoint

GET https://api.connectly.ai/v1/businesses/{businessId}/webhooks

Example request

curl --request GET \
  --url https://api.connectly.ai/v1/businesses/{businessId}/webhooks \
  --header 'Accept: application/json' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

{
  "entity": {
    "businessId": "biz_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "webhooks": [
      {
        "id": "wh_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "topic": "messages",
        "address": "https://example.com/webhook/messages",
        "configuration": {
          "echo": false,
          "channelTypes": ["whatsapp"],
          "filters": []
        }
      },
      {
        "id": "wh_02BRY4OEFLTUW5SSGGH70H6GBW",
        "topic": "delivery_status",
        "address": "https://example.com/webhook/delivery",
        "configuration": {
          "echo": false,
          "channelTypes": ["whatsapp"],
          "filters": [
            { "field": "campaign_name", "expression": "summer-promo-*" }
          ]
        }
      }
    ]
  }
}
Response fields:
FieldDescription
entity.businessIdThe business ID these registrations belong to.
entity.webhooksArray of webhook registration objects. Empty array if none are configured.
webhooks[].idUnique identifier for this registration. Use with Update webhook and Delete webhook.
webhooks[].topicThe subscribed topic: messages or delivery_status.
webhooks[].addressThe endpoint URL receiving events for this topic.
webhooks[].configuration.echoWhether outbound messages are echoed back to this webhook.
webhooks[].configuration.channelTypesChannel types this webhook filters on.
webhooks[].configuration.filtersActive filter rules — each has a field and expression.
webhooks[].configuration.webengageConfigurationPresent only for WebEngage-type webhooks. Contains webengageToken and webengageWebhookUrl.

Error responses

StatusMeaning
401Missing or invalid X-API-Key.
404The specified businessId does not exist.
500Internal server error.