Transactional SMS Events
The Event Notification Service supports these event notification types and their corresponding payloads.
| Notification Event Type | Description |
|---|---|
TransactionalSendEvents.SmsSent | Indicates that the SMS message was sent to the aggregator. |
TransactionalSendEvents.SmsNotSent | Indicates that the SMS message was not sent and includes the reason. |
TransactionalSendEvents.SmsTransient | Indicates the most recent transmission status between Salesforce and the mobile device. Not the final disposition. This information is provided by our delivery partners and mobile carriers but is not available in all locales. No actions to take. |
TransactionalSendEvents.SmsBounced | Indicates that the SMS message bounced and includes the reason. |
TransactionalSendEvents.SmsDelivered | Indicates that the SMS message was delivered. |
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 | A unique job ID. |
composite.batchId | string | A unique batch ID. |
composite.listId | string | A 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.SmsSent event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsNotSent event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsTransient event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsDelivered event.
This event notification payload is an example of what your callback receives for a TransactionalSendEvents.SmsBounced event.