Webhook Payload

​
This section goes over the different types of webhook messages that you can receive. Currently, Connectly only supports WhatsApp messages.

Payload plain text:

JSON
{
"timestamp": "1639083206",
"sender": {
"id": "+16315555500",
"channelType": "whatsapp",
"name": "Vasi from Connectly"
},
"recipient": {
"id": "+16044441234",
"channelType": "whatsapp",
"name": "connectlyai"
},
"message": {
"text": "TEST 11"
}
}

Payload media:

JSON
{
"timestamp": "1639085537",
"sender": {
"id": "+16315555500",
"channelType": "whatsapp",
"name": "Vasi from Connectly"
},
"recipient": {
"id": "+16044441234",
"channelType": "whatsapp",
"name": "connectlyai"
},
"message": {
"attachments": [
{
"type": "video",
"url": "https://cdn.dev.connectly.ai/asd/asdasdasdasd"
}
]
}
}

Payload button response

JSON
{
"timestamp": "1639083206",
"sender": {
"id": "+16315555500",
"channelType": "whatsapp",
"name": "Vasi from Connectly"
},
"recipient": {
"id": "+16044441234",
"channelType": "whatsapp",
"name": "connectlyai"
},
"message": {
"text": "TEST 11",
"isButtonResponse": true
}
}

Payload delivery status

JSON
{
"topic": "delivery_status",
"timestamp": "1641513098",
"sender": {
"id": "+16044441234",
"channelType": "whatsapp",
"name": "connectlyai"
},
"recipient": {
"id": "+16315555500",
"channelType": "whatsapp",
"name": "Vasi from Connectly"
},
"statusUpdate": {
"id": "01FRRWW2ZAHD9GJ1SWY4VF2GBD",
"status": "delivered",
"error": null
},
"metadata": {
"campaign_name": "<YOUR_CAMPAIGN_NAME>"
}
}

Payload delivery status error

JSON
{
"topic": "delivery_status",
"timestamp": "1641512856",
"sender": {
"id": "+16044441234",
"channelType": "whatsapp",
"name": "connectlyai"
},
"recipient": {
"id": "+16315555500",
"channelType": "whatsapp",
"name": "Vasi from Connectly"
},
"statusUpdate": {
"id": "01FRRWMSAMKNFZAMBPQ65CA7DD",
"status": "delivery_failed",
"error": {
"message": "Message template inputs invalid",
"type": "ERROR_TYPE_INVALID_REQUEST",
"code": "ERROR_CODE_MESSAGE_TEMPLATE_INPUT_INVALID",
"userTitle": "Message template inputs invalid",
"userMessage": "Pass along the connectly trace id 'cnct_trace_id' to the team for more information.",
"cntTraceId": "10827968052975079261",
"details": {
}
},
"metadata": {
"campaign_name": "<YOUR_CAMPAIGN_NAME>"
}
}
}