Connectly Documentation
  • 👋Welcome to Connectly.ai
  • 🚀Quick Start
    • Prerequisites
    • Authentication
    • Send WhatsApp template message
    • Send WhatsApp session message
  • 📣Campaigns
    • Campaign Sendout
      • Send Campaigns
  • 🤖Sofia AI
    • How to use Sofia AI?
    • Sofia AI API
      • Reference
        • Core Concepts
        • sales_assistant_v2/invoke/v1
  • 📱Message API
    • Message Service API
      • MessageService
        • Send template message
        • Send session message
      • Error codes
    • Webhook API
      • WebhookService
        • Create a webhook registration by event topic
        • Update an existing webhook registration by event topic
        • Get webhook registrations for business
        • Delete a webhook registration for business
      • Webhook Payload
        • Delivery Status Error Codes
        • Payload Media Types
  • 🤖Business Management
    • Business Management API
      • Template Management
        • Create a template
        • Get templates
      • Quality Signals
  • 📱Integrations
    • Integrations
      • WebEngage Integration
      • Message your customers on Zendesk through Connectly
      • Message your customer on Intercom through Connectly
    • [Alpha] Moengage
      • MessageService
        • Send Campaign via API
  • 📊Analytics
    • Analytics
      • [Alpha] Campaign report
      • Reports API
        • Webhooks configuration
  • 👀FAQ
  • Migrating WhatsApp Accounts
  • How to use time delay?
Powered by GitBook
On this page
  1. Message API
  2. Webhook API
  3. WebhookService

Get webhook registrations for business

PreviousUpdate an existing webhook registration by event topicNextDelete a webhook registration for business

Last updated 3 years ago

📱
get

API to get a webhook registrations for business

Authorizations
Path parameters
businessIdstringRequired
Responses
200
A successful response.
application/json
201
Successful response containing details of webhook subscriptions for business.
application/json
default
An unexpected error response.
application/json
get
GET /v1/businesses/{businessId}/webhooks HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "entity": {
    "businessId": "text",
    "webhooks": [
      {
        "topic": "topic_unspecified",
        "address": "text",
        "id": "text",
        "configuration": {
          "echo": true,
          "channelTypes": [
            "sms"
          ],
          "webengageConfiguration": {
            "webengageToken": "text",
            "webengageWebhookUrl": "text"
          },
          "filters": [
            {
              "field": "campaign_name",
              "expression": "test-campaign-*"
            }
          ]
        }
      }
    ]
  }
}