channels
email
email-webhooks

Receive user events

For each email that you send out, we can send you a tracking report for opened, clicked, complained, late bounce and unsubscribed. All you need to do is specify your endpoint when sending email and we will deliver a report to you in real time.

postWebhookreceive-email-tracking-reports

Payload

notificationTypestring

Tells the type of user event that took place. Possible events: OPENED, CLICKED, COMPLAINED, LATE_BOUNCE, UNSUBSCRIBED, ARTIFICIAL_CLICKED.

eventIdstring

Unique ID of the event. This ID can be used for deduplication purposes.

domainstring

The sending domain used to send the email to the recipient.

recipientstring

Recipient of the email.

urlstring

The link the recipient has clicked. This attribute will only be present if the event is of the type CLICKED or ARTIFICIAL_CLICKED.

sendDateTimenumber

The time at which the event happened. Time is in milliseconds.

messageIdstring

The ID that uniquely identifies the message sent to the recipient.

bulkIdstring

The ID that uniquely identifies a list of email messages. This is either defined by user in the request or auto generated.

callbackDatastring

The callback data sent through the callbackData field in your fully featured Email message.

campaignReferenceIdstring

ID of a campaign that was sent in the message.

entityIdstring

Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.

applicationIdstring

Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.

Response

Your server returns this code if it accepts the callback.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.