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

API to create a new webhook registration by event topic

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Currently, ONLY WHATSAPP webhook events are supported

Register your endpoint to receive Connectly webhook events

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

  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.

Available topics

TopicDescription
messagesSubscribes you to receive WhatsApp messages from your clients

{"timestamp":"1640203838", "sender":{"id":"+16044441111", "channelType":"whatsapp"}, "recipient":{"id":"+16041112222", "channelType":"whatsapp"}, "message":{"text":"hello"}}
delivery_statusSubscribes you to receive WhatsApp delivery status updates. These events tell you the transmission status of your message:

- delivered
- read
- delivery_failure
Path Params
string
required
Body Params
string
enum
Defaults to messages

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

Allowed:
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json