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 CategoryNotification Event TypeData Items Available for Filtering
TransactionalSendEventsEmailSent, SMSSentdefinitionKey
TransactionalSendEventsEmailNotSent, SMSNotSentdefinitionKey, statusCode
TransactionalSendEventsEmailBounceddefinitionKey, bounceCode, smtpReason
SendEventsAutomationInstanceStartedautomationName, automationCustomerKey, automationType
SendEventsAutomationInstanceCompletedautomationName, automationCustomerKey, automationType
SendEventsAutomationInstanceStoppedautomationName, automationCustomerKey, automationType
SendEventsAutomationInstanceErroredautomationName, automationCustomerKey, automationType
SendEventsAutomationInstanceSkippedautomationName, automationCustomerKey, automationType
SendEventsPushSent, PushNotSent, PushBouncedsendMethod
EngagementEventsPushOpen, OttSent, OttDelivered, OttRead, OttFailed, OttMobileOriginatedsendMethod

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.