The payload's event JSON object contains the following items:
| Field | Type | Description |
|---|
| category | String | The name of the event category. See the full list below. |
| date | String | The datetime the event happenned in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). |
| diagnostic-code | String | The bounce's SMTP diagnostic code (e.g. 'x-unix; maildrop: maildir over quota.'). Only these categories include this field: bounce, blocked. |
| mx | String | The domain responsible for accepting the recipient's emails. |
| recipient | String | The recipient's email address. |
| status-code | String | The bounce's SMTP status code (e.g. '4.3.0'). Only these categories include this field: bounce, blocked. |
| tags | Array | An array containing the tags that the email is related with. Each tag's type is String. |
| uid | String | An alphanumeric string up to 100 characters containing the UID of the email (e.g. A650139AB25-4E13A10D349EF3712ACC). |
The list of event categories is:
- open: When the recipient opens an email. Counted only for HTML emails and image-view-enabled recipients.
- click: When the recipient clicks a link in your email.
- unsubscribed: When the recipient unsubscribed from your email traffic.
- bounce: When we receive a bounce (either soft or hard) for an email of yours. Future emails to that address *will be* delivered.
- hard_bounce: Deprecated in favor of 'bounce'.
- soft_bounce: Deprecated in favor of 'bounce'.
- blocked: When we receive a notification from a recipient's servers that an email of yours has been blocked for spam or content reasons. Future emails to that address *will be* delivered.
- spam_report: When a user has reported an email of yours as Spam to an ISP within our Feedback Loop. Future emails to that address will *not* be delivered.
- filtered: When we filter an email of yours and it is not sent out (due to various reasons like we have received too many permanent failures for the address or it has been unsubscribed or it has sent a spam report etc).
- error: When there is an email's structure or other internal error.
- new_failed_address: When we filter an email address after receiving too many permanent failures for it. Future emails to that address will *not* be delivered.
- filtered_address: Deprecated in favor of 'new_failed_address'
- blacklisted_address: When a user blacklists an address from here. Future emails to that address will *not* be delivered.
- unblacklisted_address: When a user unblacklists an address from here. Future emails to that address *will be* delivered.
- freed_address: When we remove an email address during our periodic failed addresses' assessment and cleanup procedure (failed addresses are those we have received too many permanent failures for). Future emails to that address *will be* delivered.
Note 1: The event's JSON representation fields should not be considered as fixed. Later on, new JSON fields may be added.
Note 2: All deprecated events will stop being sent by 1st March 2013. Until then, we will send both the old (deprecated) and the new events.
Errors: If there are errors decoding your tags or other you have returned you will recieve the following error in the form of JSON:
[
{
"error": "Invalid Character",
},
]