After setting up a Custom Webhook, you will receive the payload from your endpoints. Here are the definitions for each column
chat_title
The display name of the chat. In a 1:1 chat, it will be the saved name of the contact or the phone number of the contact. In a group chat, the chat title will be the name of the group.
sender_phone, sender_name
These fields represent the sender's name and phone number. If the message direction is 'sent,' the contact field will be you; if the message direction is 'received,' the contact field will be your client.
participants
This column lists ALL the participants in this chat, along with their phone numbers and WhatsApp names, including the current Cooby user.
user_phone, user_email
These fields indicate the current logged-in Cooby user's phone number and email.
direction
This column indicates the direction of the message in reference to the Cooby user.
message
type
This column specifies the type of the message.
text
This column contains the message content.
Only chat, image, video, and document message types have text in the form of message text; other types will not have a text field
file_url
We will show a url link for you to download the file.
Cooby only support multimedia files up to 15 MB
timestamp
This column displays the UTC datetime when the message was sent.
Payload example
{
"chat_title": "Pinkie",
"sender": {
"phone": "447441368384",
"wa_name": "Cooby"
},
"participants": [
{
"phone": "447441369136",
"wa_name": "pinkiebala"
},
{
"phone": "447441368384",
"wa_name": "Cooby"
}
],
"user_phone": "447441368384",
"user_email": "[email protected]",
"direction": "sent",
"message": {
"type": "image",
"text": "Hi",
"file_url": "https://api.cooby.co/v2/files/3zVwL--j3oeeyabpMkiwPXm0jDEsbK_I9EOUzhdoe3cC4x_YhUm64D1hhpwBdTDKvsjJJgk3SlKmmYA="
},
"timestamp": "1715150681"
}
We hope this document helps you better understand how Cooby works. For any concerns or questions regarding your Custom Webhook integration, kindly email us at [email protected] 💜