Create a webhook registration by event topic

Register your endpoint to receive Connectly webhook events

API to create a new webhook registration by event topic

post

/v1/businesses/{businessId}/create/webhooks

Authorizations

Path parameters

businessIdanyrequired

Body

topicstring · enum · default: topic_unspecified

Topic is an enum for data topic a business can register webhooks for to receive updates for registered topic(s).

Options: topic_unspecified, messages, delivery_status

addressstring

typestring · enum · default: webhook_type_unspecified

Options: webhook_type_unspecified, custom, zapier, webengage, integromat_make

configurationobject

to extend with other dimensions of the webhook topics as we go, i.e. channel_type, fields, etc.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/businesses/{businessId}/create/webhooks' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "topic": "topic_unspecified",
    "address": "text",
    "type": "webhook_type_unspecified",
    "configuration": {
      "webengageConfiguration": {
        "webengageToken": "text",
        "webengageWebhookUrl": "text"
      },
      "echo": true,
      "channelTypes": [
        "sms"
      ],
      "filters": [
        {
          "field": "campaign_name",
          "expression": "test-campaign-*"
        }
      ]
    }
  }'

200

201

default

200

{
  "id": "text"
}

A successful response.

You can provide your endpoint to receive Connectly webhook events. When creating an endpoint you need to provide the following:

1. your endpoint address

2. webhook topic you are interested to receive events from

You can only register one endpoint address per each webhook topic.

Examples

To register your endpoint to receive client messages, you can send a post request to the above URL with:

{
    "topic":"messages",
    "address":"<YOUR_ENDPOINT>"
}

Later when clients message back, you will receive a payload similar to the following:

{u'sender': {u'channelType': u'whatsapp', u'id': u'[phone]', u'name': u'Tom'}, u'timestamp': u'1661301940', u'buttonResponse': {u'text': u'Yes I'm interested', u'id': u'01GB6MZR50BY04MDAQH6TVYN40', u'payload': u'1'}, u'topic': u'messages', u'recipient': {u'channelType': u'whatsapp', u'id': u'[phone]', u'name': u'Business'}, u'metadata': None}

Available topics

Topic	Description
messages	Subscribes you to receive WhatsApp messages from your clients {"timestamp":"1640203838", "sender":{"id":"[phone]", "channelType":"whatsapp"}, "recipient":{"id":"[phone]", "channelType":"whatsapp"}, "message":{"text":"hello"}}
delivery_status	Subscribes you to receive WhatsApp delivery status updates. These events tell you the transmission status of your message: - delivered - read - delivery_failed