Transactional Email Events
The Event Notification Service supports these event notification types and their corresponding payloads.
| Notification Event Type | Description |
|---|---|
TransactionalSendEvents.EmailSent | Indicates that the email was sent to the email provider. |
TransactionalSendEvents.EmailNotSent | Indicates that the email was not sent and includes the reason. |
TransactionalSendEvents.EmailBounced | Indicates that the email bounced and includes the reason. |
All or some of these attributes are shared for all event data payloads.
| Attribute | Type | Description |
|---|---|---|
eventCategoryType | string | The taxonomy of the event |
timestampUTC | number | UTC Epoch time |
compositeId | string | Internal tracking ID (deprecated) |
composite | object | Object containing broken down composite ID |
composite.jobId | string | The unique job ID. |
composite.batchId | string | The unique batch ID. |
composite.listId | string | The unique list ID. |
definitionKey | string | Send Definition Customer Key (Transactional Sent Events Only) |
definitionId | string | Send Definition Id (Transactional Sent Events Only) |
mid | number | Tenant Business Unit Id event was produced from |
eid | number | Tenant Enterprise Id event was produced from |
info | object | Object containing event-specific details |
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailSent event.
| Attribute | Type | Description |
|---|---|---|
| to | string | The recipient's email address |
| subscriberKey | string | The unique ID of the recipient |
| messageKey | string | Object containing event-specific details |
| status | string | Result of the Sent Event |
| renderedSubject | string | The subject line after personalization |
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailNotSent event.
| Attribute | Type | Description |
|---|---|---|
| to | string | The recipient's email address |
| subscriberKey | string | The unique ID of the recipient |
| messageKey | string | Object containing event-specific details |
| reason | string | The descriptive reason |
| statusCode | string | The subscriber error code |
| statusMessage | string | The subscriber error message |
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.EmailBounced event.
| Attribute | Type | Description |
|---|---|---|
to | string | The recipient's email address |
subscriberKey | string | The unique ID of the recipient |
messageKey | string | Object containing event-specific details |
bounceCode | string | The type of bounce - "HARD" or "SOFT" |
bounceMessage | string | The string from the recipient email send the provider |
smtpReason | string | The error value of the SMTP reason |