Opens

An open event occurs when a recipient opens your 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	Name of the event.
action_by	String	Indicates by whom the action was made.
action_time	Long	Time at which the open event happened.
contact_id	Long	ID of the contact who opened the email.
contact_email	String	Email address of the contact who opened the email.
data	JSON Array	An array of data about the events.
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 an open event

Copied{
  "webhook_name": "Open webhook",
  "webhook_id": "1314909000000063004",
  "action": "email_open",
  "actionType": "email_open",
  "action_by": "contact",
  "data": [
    {
      "action_time": 1725461219774,
      "contact_id": 1314909000000144100,
      "contact_email": "john.doe@zylker.com",
      "rcpt_additional_data": {
        "country": "JP",
        "ph": "1239333320"
      },
      "transmission_name": "My first Email API Campaign",
      "injected_time": 1725543431000,
      "transmission_id": 13149090000001440022131,
      "zuid": 8575431221455
    }
  ]
}