What are the different Webhooks format?
Supported Events: We currently support Webhook on a number of events, which are:
| Event | Description |
| Sent | Message has been sent successfully |
| Dropped | Message got dropped |
| Bounced | Message has hard bounce |
| Opened | Message got opened |
| Clicked | Recipient clicked a link in the message; will only occur when click tracking is enabled |
| Unsubscribed | Recipient Unsubscribed |
| Invalid | Syntactically incorrect email ids |
| Abuse | Recipient marked the message as spam |
Why can’t my Webhook or call-back URL be verified?
When you add the URL, Netcore Email API does a test HTTP(s) POST.
If the data POST is successfully accepted by your server then Netcore Email API verifies and saves the webhook URL
Event Data
Below is the sample data for each event which will show you the actual fields which were returned in the HTTP(s) POST:
Glossary
| Parameters Used | Supported by Events | Description |
| TRANSID | All | All assigns a Unique Transaction ID for each and every email which were sent |
| All | Recipient’s Email ID | |
| EVENT | All | Type of Event: sent/ dropped/ invalid/ bounced/ opened/ clicked/ unsubscribed/ abuse |
| RESPONSE | sent/ dropped/invalid/ bounce | Response received from the end server like Delivery Logs, Bounce reason, reason for drop(blacklisted user / already unsubscribed) |
| X-APIHEADER | All | Information passed by you in the X-APIHEADER, during the time of email sent |
| TIMESTAMP | All | Unix Timestamp of the occurrence of the event |
| USERAGENT | opened/ clicked/ unsubscribed/abuse | User agent contains the detailed information about the browser from where a specific event in initiated. |
| IPADDRESS | opened/ clicked/unsubscribed/abuse | IP address of the device from where the recipient has responded. |
Sent
Email has been successfully delivered to the receiving server:
Sample sent webhook data
An example of the full JSON that would be POSTed to your webhook URL is:
[
{
"TRANSID":"14652378013752608",
"RCPTID":"0",
"RESPONSE":"smtp;250 2.0.0 OK 1465276276 mo3si31128106wjb.147 – gsmtp",
"EMAIL":"[email protected]",
"TIMESTAMP":"1465276276",
"CLIENTID":"10001",
"FROMADDRESS":"[email protected]",
"EVENT":"sent",
"MSIZE":"1216"
}
]
Dropped
Users who have already unsubscribed in past or blacklisted because of hard bounce/Spam complaints will be treated as dropped. And, no further email communication is allowed on these types of ids.
[
{
“TRANSID”:”14652378021238672″,
“RCPTID”:”0″,
“RESPONSE”:”Recipient Dropped :: status not confirmed”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465300547″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”dropped”,
“MSIZE”:”575″
}
]
Invalid
All API requests with syntactically incorrect email ids will be treated as Invalid and no further processing will be done on such ids. You can capture all such invalid events in real time and try correcting them offline.
[
{
“TRANSID”:”14652378021198302″,
“RCPTID”:””,
“RESPONSE”:”Invalid Email Address”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465300638″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”invalid”,
“MSIZE”:”16900″
}
]
Bounced
Receiving server could not or would not accept message because of multiple reasons like receiving server is not reachable, email id doesn’t exists etc. All such reasons are a part of Hard Bounce which will lead to the blacklisting of that email id in Netcore Email API system. There are other set of bounces which are treated as Soft Bounce, e.g. Mailbox full. These are temporary bounces.
Hard Bounce
[
{
“TRANSID”:”14652378014624064″,
“RCPTID”:”0″,
“RESPONSE”:”smtp;550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient’s email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/answer/6596 z130si23626456iod.1″,
“BOUNCE_TYPE”:”HARDBOUNCE”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465277622″,
“BOUNCE_REASONID”:”77″,
“CLIENTID”:”10001″,
“BOUNCE_REASON”:”email account that you tried to reach does not exist”,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”bounced”,
“MSIZE”:”10″,
“USERAGENT”:”10″
}
]
Soft Bounce
[
{
“TRANSID”:”14652378014624064″,
“RCPTID”:”0″,
“RESPONSE”:”smtp;550 5.1.1 Mail box full”,
“BOUNCE_TYPE”:”SOFTBOUNCE”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465277622″,
“BOUNCE_REASONID”:”1099″,
“CLIENTID”:”10001″,
“BOUNCE_REASON”:”mail box full for the account you reached”,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”bounced”,
“MSIZE”:”10″,
“USERAGENT”:”10″
}
]
Opened
Recipient has opened the email.
[
{
“TRANSID”:”14652378013752608″,
“RCPTID”:”0″,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465276362″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”opened”,
“MSIZE”:”1216″,
“USERAGENT”:”Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)”,
“IPADDRESS”:”64.233.173.70″
}
]
Clicked
Recipient has clicked on a link within the message.
[
{
“TRANSID”:”14652378018802172″,
“RCPTID”:”[email protected]”,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465299696″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”clicked”,
“MSIZE”:”19379″,
“USERAGENT”:”Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36″,
“URL”:”https://www.pepipost.com”,
“IPADDRESS”:”11.11.11.16″
}
]
Unsubscribed
Recipient clicked on the unsubscribe management link.
[
{
“TRANSID”:”14652378014983009″,
“RCPTID”:”4″,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465278512″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”unsubscribed”,
“MSIZE”:”1718″,
“USERAGENT”:”Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36″,
“IPADDRESS”:”19.16.11.11″
}
]
Abuse
Recipient who marked the email as Spam
[
{
“TRANSID”:”14652378014983009″,
“RCPTID”:”4″,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465278512″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”abuse”,
“MSIZE”:”1718″,
“USERAGENT”:”Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36″,
“IPADDRESS”:”19.16.11.11″
}
]
Can I view failed Webhook batches?
No
Updated about 3 years ago