To receive webhook requests about the recipient’s click on link buttons from a WhatsApp message, go to the Integration → Settings section in your edna Pulse account and in the Webhook URL for tracking clicks on the WhatsApp link button setting, specify the URL for webhook requests — the endpoint of your system that will process incoming POST requests from edna Pulse.
Webhook Request Format
{
"payload": {
"sender": "string",
"templateId": integer,
"channelType": "WHATSAPP",
"outMessageId": integer,
"phone": "string",
"url": "string",
"shortLink": "string"
},
"type": "string",
"version": "string",
"timestamp": "string"
}
Webhook Request Example
{
"payload": {
"sender": "test-channel",
"templateId": 1333,
"channelType": "WHATSAPP",
"outMessageId": 5345345,
"phone": "37512312312",
"url": "google.ru",
"shortLink": "https://evtb.me/link/f42kL"
},
"type": "short_link_visited",
"version": "v1",
"timestamp": "2025-08-10T12:32:56Z"
}
Webhook Request Parameters
| Parameter | Data type | Character | Description |
|---|---|---|---|
payload | object | Required | Information about event types. |
payload.sender | string | Required | The name of the signature. To find out the name of the signature, use the API method to get a list of channels — the subject parameter. |
payload.templateId | integer | Required | The template ID. To find out the template ID, use the API method to get a list of templates — the id parameter. |
payload.channelType | string | Required | Channel type. Possible value is WHATSAPP (WhatsApp channel). |
payload.outMessageId | integer | Required | The ID of the message. |
payload.phone | string | Required | The recipient’s address is a phone number.To find out the recipient’s address, use the API method for requesting recipient data — the addresses.address parameter. |
payload.url | string | Required | The initial link of the button with static and dynamic parts. To find out the original link of the button, use the API method to get a list of templates — the content.keyboard.rows.buttons.url parameter. |
payload.shortLink | string | Required | A unique button link, replaced individually for each recipient of the WhatsApp message. |
type | string | Required | The type of event that the webhook request is being sent about. |
version | string | Required | The version of the API method. |
timestamp | string | Required | The time of updating the category in the WhatsApp template. Specified in the ISO 8601 format (for example, 2025-07-01T00:00:00Z). |
Response Format
In response to a webhook request from your server, the status code 200 should be returned.
If the 200 status is not returned in response to the webhook request, edna Pulse performs 10 more attempts to send a webhook request with an interval of 2 seconds between attempts (where X is the attempt number) until the 200 code is received in response (i.e. every 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048 seconds).