Delivered
A delivered event occurs when a mail successfully reaches the recipient's mail server. Please note that this does not mean the email has landed in the inbox or the recipient has read the email.
List of Body Attributes
This table shows the list of parameters present in the payload and their explanations.
Parameters | Data Type | Description |
webhook_name | String | Name of the webhook you configured. |
webhook_id | String | ID of the configured webhook |
action | String | Name of the event. |
actionType | String | Type of action; in this case it is a delivered action. |
action_by | String | Indicates by whom the action was made. |
data | JSON Array | An array of data about the events |
action_time | Long | Time at which the delivered event happened. |
contact_id | Long | ID of the contact to which the mail was attempted, but was bounced. |
contact_email | String | Email address of the contact to which the mail was attempted, but was bounced. |
rcpt_additional_data | JSON Object | Additional data of the recipient that was provided by you in Transmission API or Recipient List API. |
transmission_name | String | The name you provided for the transmission in Transmission API. |
injected_time | Long | The time the transmission was created. |
transmission_id | Long | The ID of the transmission. |
zuid | Long | The ID of the user that sent the transmission API request. |
Sample Payload for a Delivered Event
Copied{
"webhook_name": "Delivered webhook",
"webhook_id": "1314909000000063006",
"action": "email_delivered",
"actionType": "email_delivered",
"action_by": "user",
"data": [
{
"action_time": 1725461219974,
"contact_id": 1314909000000144100,
"contact_email": "john.doe@zylker.com",
"rcpt_additional_data": {
"country": "JP",
"Phone": "1239333320"
},
"transmission_name": "My first Email API Campaign",
"injected_time": 1725543431000,
"transmission_id": 1.314909000000144e+22,
"zuid": 8575431221455
}
]
}