Platform Event Filters

Using Tooling API or Metadata API, an administrator with the Customize Application permission can configure a complex filter expression that contains multiple fields.

The filter expression is associated with a custom channel and is included in a channel member. You can add one or more filter expressions via channel members to a custom channel. For more information about channels and their allocations, see Group Platform Events into One Stream with a Custom Channel.

  • Filter Expression Format

    The filter expression format is based on SOQL and supports a subset of SOQL operators and field types. The filter expression can contain one or more field expressions, joined by a logical operator.

  • Field Considerations

    Keep these considerations in mind for the fields in a filter expression.

  • Event Delivery Usage for Filtered Streams

    The event delivery allocation applies to the number of events delivered after the filter is applied and not before filtering. Because a filter can reduce the number of events delivered to a subscriber, using a filter helps lower a subscriber’s usage of the event delivery allocation.