Create a webhook registration by event topic
Last updated
Last updated
You can provide your endpoint to receive Connectly webhook events. When creating an endpoint you need to provide the following:
your endpoint address
webhook topic you are interested to receive events from
You can only register one endpoint address per each webhook topic.
To register your endpoint to receive client messages, you can send a post request to the above URL with:
Later when clients message back, you will receive a payload similar to the following:
messages
Subscribes you to receive WhatsApp messages from your clients {"timestamp":"1640203838", "sender":{"id":"+16044441111", "channelType":"whatsapp"}, "recipient":{"id":"+16041112222", "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
API to create a new webhook registration by event topic
/v1/businesses/{businessId}/create/webhooks
Topic is an enum for data topic a business can register webhooks for to receive updates for registered topic(s).
topic_unspecified
, messages
, delivery_status
webhook_type_unspecified
, custom
, zapier
, webengage
, integromat_make