{
"type": "message.clicked",
"webhook_id": "abe11757-2886-4b55-96f1-0e0afc95795a",
"timestamp": "2024-05-06T10:20:16.687031577Z",
"data": {
"account_id": "4cdd7bdd-294e-4762-892f-83d40abf5a87",
"event": "on_clicked",
"from": "sender@example.com",
"recipient": "recipient@example.com",
"subject": "Welcome to our service",
"message_id_header": "<message-id-12345@localhost>",
"id": "407926766d2711f09b30960002cafe7c",
"url": "https://example.com/landing-page",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
"ip": "192.168.1.100",
"is_bot": false
}
}Message Events
Message Click Webhook
Triggered when the recipient clicks a tracked link in your email.
Requirements:
- Click tracking must be enabled for your account or this specific email
- The clicked link must be processed by AhaSend’s click tracking system
Additional Data: This webhook includes user agent and IP address information for analytics.
When it’s sent: When a tracked link in the email is clicked.
WEBHOOK
message.clicked
{
"type": "message.clicked",
"webhook_id": "abe11757-2886-4b55-96f1-0e0afc95795a",
"timestamp": "2024-05-06T10:20:16.687031577Z",
"data": {
"account_id": "4cdd7bdd-294e-4762-892f-83d40abf5a87",
"event": "on_clicked",
"from": "sender@example.com",
"recipient": "recipient@example.com",
"subject": "Welcome to our service",
"message_id_header": "<message-id-12345@localhost>",
"id": "407926766d2711f09b30960002cafe7c",
"url": "https://example.com/landing-page",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
"ip": "192.168.1.100",
"is_bot": false
}
}Body
application/json
The event type
Available options:
message.clicked The webhook ID (the same ID as returned by the Create Webhook API)
When the event occurred (ISO 8601 format)
Show child attributes
Show child attributes
Response
Webhook received successfully