Subscription Filters
Your Event Notification Service subscription can filter the notifications that are sent to the associated callback. Filters are expressed as a list of one or more name=value pairs on the subscription.
To deliver the notification event to the callback, the name-value pairs must all be true.
The following data items are available for subscription filtering for each transactional send event type.
Notification Event Category | Notification Event Type | Data Items Available for Filtering |
---|---|---|
TransactionalSendEvents | EmailSent , SMSSent | definitionKey |
TransactionalSendEvents | EmailNotSent , SMSNotSent | definitionKey , statusCode |
TransactionalSendEvents | EmailBounced | definitionKey , bounceCode , smtpReason |
SendEvents | AutomationInstanceStarted | automationName , automationCustomerKey , automationType |
SendEvents | AutomationInstanceCompleted | automationName , automationCustomerKey , automationType |
SendEvents | AutomationInstanceStopped | automationName , automationCustomerKey , automationType |
SendEvents | AutomationInstanceErrored | automationName , automationCustomerKey , automationType |
SendEvents | AutomationInstanceSkipped | automationName , automationCustomerKey , automationType |
SendEvents | PushSent , PushNotSent , PushBounced | sendMethod |
EngagementEvents | PushOpen , OttSent , OttDelivered , OttRead , OttFailed , OttMobileOriginated | sendMethod |
To filter TransactionalSendEvents.EmailSent
events for a specific transactional send definition, include the following subscription filter when you create a subscription.
If you apply this filter to a subscription for TransactionalSendEvents.EmailSent
events, the callback receives TransactionalSendEvents.EmailSent
notification events only for the transactional send definition of 12345
. All other TransactionalSendEvents.EmailSent
notification events are filtered out and not delivered to the callback.