RudderStack's client-side event filtering feature lets you specify which events should be discarded or allowed to flow through by allowlisting or denylisting them.
You can use this feature for all the RudderStack destinations that support sending events via the device mode.
Client-side event filtering is applicable only for
track calls. In case of mobile SDKs, it also applies to the following application lifecycle events:
- Application Installed
- Application Opened
- Application Backgrounded
- Application Updated
The following source SDKs support this feature:
RudderStack gives you the ability to configure your event filtering options while setting up your device mode destination in the dashboard, as shown:
You will see the following dropdown options under Event Filtering, in the Connection Settings page:
Event filtering will be disabled if you select this option from the dropdown. In this case, RudderStack will not filter any events and allow all events to flow through.
Upon selecting the Allowlist option from the dropdown, you can specify the names of the events that you want RudderStack to allow or flow through to the destination.
If you choose the Allowlist option for event filtering, any events specified in the Denylist field will be ignored.
You can add as many events as you want to the allowlist by clicking the Add More option.
RudderStack will discard any event that is not specified in the allowlist. If you do not specify any events in the allowlist, all the calls will be discarded.
Upon selecting the Denylist option from the dropdown, you can specify the names of the events that you want RudderStack to discard. These events will not be sent to the destination.
If you choose the Denylist option for event filtering, any events specified in the Allowlist field will be ignored.
You can add as many events as you want to the denylist by clicking on the Add More option.
RudderStack will only discard events explicitly specified in the denylist. If you do not specify any events in the denylist, then all calls will be allowed through.