Instant email notifications with webhooks
The webhooks in ZeptoMail ensure that you’re instantly notified about message events on your transactional emails. Stay informed of delivery issues and recipient activity.
SIGN UP NOWWhat are webhooks?
A webhook is a mechanism that allows data to flow between two applications synchronously. A specified event triggers an HTTP POST request with the relevant event data to a pre-defined URL.
Webhooks in ZeptoMail
With webhooks in ZeptoMail, you can sync data, streamline information, and improve deliverability by staying informed.
Fast setup
Configure your webhooks in ZeptoMail within minutes. Simply provide the endpoint URL and choose the events you want to be notified about.
Instant updates
Unlike traditional APIs, where there is a need to constantly check for new data, webhooks are instantly triggered when an event occurs.
Pick your events
Configure webhooks to deliver notifications about important message events instantly. You get control over which events you'll be notified about and to which URL.
Add email metadata
Easily identify notifications by including the metadata of the email with the webhook request. Keep your users informed and up to date about their email delivery status.
Secure requests
A webhook endpoint is required to be a public URL. To secure the URL against unsolicited requests, you can use the webhook authentication key in ZeptoMail.
Test webhook
You can trigger a test request to see if your webhook configuration is working how wish it to.
Webhook email events
You can pick from different message events every time you configure a webhook. You can choose just one or a combination of these events.
Soft bounce webhook
Hard bounce webhook
Open tracking webhook
Click tracking webhook
{
"event_name": ["softbounce"],
"event_message": [
{
"email_info": {
"cc": [
{
"email_address": {
"address": "alia@zohomail.com",
"name": "Alia"
}
}
],
"client_reference": "customer-unique-reference-to-identify-the-mail",
"bcc": [
{
"email_address": {
"address": "richard@zohomail.com",
"name": "Richard"
}
}
],
"is_smtp_trigger": false,
"subject": "Zylker Orders",
"bounce_address": "orders@zylker.com",
"email_reference": "2d6f.2f584a3cd668e3a6.m1.13e7de70-95ca-11ef-9a6d-525400ae9113.192d73eadd7@zylker.com",
"reply_to": [
{
"address": "replyto@zylker.com",
"name": "ReplyTo"
}
],
"from": {
"address": "orders@zylker.com",
"name": "Zylker Orders"
},
"to": [
{
"email_address": {
"address": "nikki@zohomail.com",
"name": "Nikki"
}
},
{
"email_address": {
"address": "nate@zohomail.com",
"name": "Nate"
}
}
],
"tag": "unknown",
"processed_time": "2024-10-29T07:47:42Z",
"object": "email"
},
"event_data": [
{
"details": [
{
"reason": "relaying-issues",
"bounced_recipient": "nate@zohomail.com",
"time": "2024-10-29T07:47:42Z",
"diagnostic_message": "policy-related"
}
],
"object": "softbounce"
}
],
"request_id": "2d6f.2f584a3cd668e3a6.m1.13e7de70-95ca-11ef-9a6d-525400ae9113.192d73eadd7"
}
],
"mailagent_key": "2d6f.2f584a3cd668e3a6.52e320a75dbd1cc9",
"webhook_request_id": "2d6f.2f584a3cd668e3a6.w1.13e80580-95ca-11ef-9a6d-525400ae9113.192d73eadd8"
}
{
"event_name": ["hardbounce"],
"event_message": [
{
"email_info": {
"cc": [
{
"email_address": {
"address": "alia@zohomail.com",
"name": "Alia"
}
}
],
"client_reference": "customer-unique-reference-to-identify-the-mail",
"bcc": [
{
"email_address": {
"address": "richard@zohomail.com",
"name": "Richard"
}
}
],
"is_smtp_trigger": false,
"subject": "Zylker Orders",
"bounce_address": "orders@zylker.com",
"email_reference": "2d6f.2f584a3cd668e3a6.m1.5189a590-95d6-11ef-9a6d-525400ae9113.192d78ee669@zylker.com",
"reply_to": [
{
"address": "replyto@zylker.com",
"name": "ReplyTo"
}
],
"from": {
"address": "orders@zylker.com",
"name": "Zylker Orders"
},
"to": [
{
"email_address": {
"address": "nikki@zohomail.com",
"name": "Nikki"
}
},
{
"email_address": {
"address": "nate@zohomail.com",
"name": "Nate"
}
}
],
"tag": "unknown",
"processed_time": "2024-10-29T09:15:19Z",
"object": "email"
},
"event_data": [
{
"details": [
{
"reason": "relaying-issues",
"bounced_recipient": "nate@zohomail.com",
"time": "2024-10-29T09:15:19Z",
"diagnostic_message": "bad-mailbox"
}
],
"object": "hardbounce"
}
],
"request_id": "2d6f.2f584a3cd668e3a6.m1.5189a590-95d6-11ef-9a6d-525400ae9113.192d78ee669"
}
],
"mailagent_key": "2d6f.2f584a3cd668e3a6.52e320a75dbd1cc9",
"webhook_request_id": "2d6f.2f584a3cd668e3a6.w1.5189cca0-95d6-11ef-9a6d-525400ae9113.192d78ee66a"
}
{
"event_name": ["email_open"],
"event_message": [
{
"email_info": {
"cc": [
{
"email_address": {
"address": "alia@zohomail.com",
"name": "Alia"
}
}
],
"client_reference": "customer-unique-reference-to-identify-the-mail",
"bcc": [
{
"email_address": {
"address": "richard@zohomail.com",
"name": "Richard"
}
}
],
"is_smtp_trigger": false,
"subject": "Zylker Orders",
"bounce_address": "orders@zylker.com",
"email_reference": "2d6f.2f584a3cd668e3a6.m1.13e7de70-95ca-11ef-9a6d-525400ae9113.192d73eadd7@zylker.com",
"reply_to": [
{
"address": "replyto@zylker.com",
"name": "ReplyTo"
}
],
"from": {
"address": "orders@zylker.com",
"name": "Zylker Orders"
},
"to": [
{
"email_address": {
"address": "nikki@zohomail.com",
"name": "Nikki"
}
},
{
"email_address": {
"address": "nate@zohomail.com",
"name": "Nate"
}
}
],
"tag": "unknown",
"processed_time": "2024-10-29T07:47:42Z",
"object": "email"
},
"event_data": [
{
"details": [
{
"email_client": {
"name": "Ula",
"version": "1.2"
},
"modified_time": "2024-10-29T09:26:21Z",
"ip_location_info": {
"zipcode": "603202",
"country_code": "IN",
"city": "CHENNAI",
"latitude": "12.85",
"country_name": "INDIA",
"ip_address": "121.244.91.21",
"time_zone": "+530",
"region": "TAMIL NADU",
"longitude": "80.06"
},
"browser": {
"name": "Chrome",
"version": "78.0.3904.87"
},
"operating_system": {
"name": "Mac OS X",
"version": "10_13_6"
},
"time": "2024-10-29T09:26:21Z",
"device": {
"name": "Computer"
},
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.87 Safari/537.36"
}
],
"object": "email_open"
}
],
"request_id": "2d6f.2f584a3cd668e3a6.m1.dbe3a050-95d7-11ef-9a6d-525400ae9113.192d798fed5"
}
],
"mailagent_key": "2d6f.2f584a3cd668e3a6.52e320a75dbd1cc9",
"webhook_request_id": "2d6f.2f584a3cd668e3a6.w1.dbe5ea40-95d7-11ef-9a6d-525400ae9113.192d798fee4"
}
{
"event_name": ["email_link_click"],
"event_message": [
{
"email_info": {
"cc": [
{
"email_address": {
"address": "alia@zohomail.com",
"name": "Alia"
}
}
],
"client_reference": "customer-unique-reference-to-identify-the-mail",
"bcc": [
{
"email_address": {
"address": "richard@zohomail.com",
"name": "Richard"
}
}
],
"is_smtp_trigger": false,
"subject": "Zylker Orders",
"bounce_address": "orders@zylker.com",
"email_reference": "2d6f.2f584a3cd668e3a6.m1.13e7de70-95ca-11ef-9a6d-525400ae9113.192d73eadd7@zylker.com",
"reply_to": [
{
"address": "replyto@zylker.com",
"name": "ReplyTo"
}
],
"from": {
"address": "orders@zylker.com",
"name": "Zylker Orders"
},
"to": [
{
"email_address": {
"address": "nikki@zohomail.com",
"name": "Nikki"
}
},
{
"email_address": {
"address": "nate@zohomail.com",
"name": "Nate"
}
}
],
"tag": "unknown",
"processed_time": "2024-10-29T07:47:42Z",
"object": "email"
},
"event_data": [
{
"details": [
{
"email_client": {
"name": "Ula",
"version": "1.2"
},
"modified_time": "2024-10-29T09:29:22Z",
"ip_location_info": {
"zipcode": "603202",
"country_code": "IN",
"city": "CHENNAI",
"latitude": "12.85",
"country_name": "INDIA",
"ip_address": "121.244.91.21",
"time_zone": "+530",
"region": "TAMIL NADU",
"longitude": "80.06"
},
"browser": {
"name": "Chrome",
"version": "78.0.3904.87"
},
"operating_system": {
"name": "Mac OS X",
"version": "10_13_6"
},
"time": "2024-10-29T09:29:22Z",
"clicked_link": "https://www.zoho.com",
"device": {
"name": "Computer"
},
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.87 Safari/537.36"
}
],
"object": "email_link_click"
}
],
"request_id": "2d6f.2f584a3cd668e3a6.m1.4836f310-95d8-11ef-9a6d-525400ae9113.192d79bc4c1"
}
],
"mailagent_key": "2d6f.2f584a3cd668e3a6.52e320a75dbd1cc9",
"webhook_request_id": "2d6f.2f584a3cd668e3a6.w1.483879b0-95d8-11ef-9a6d-525400ae9113.192d79bc4cb"
}