Platform Events Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Set Up Debug Logs
Flows
Processes
Apex Triggers
Lightning Components
Pub/Sub API
CometD
Group Your Event Streams
Filter Your Event Streams
Platform Event Filters
Filter Expressions in Channel Members
Prerequisite: Define a Platform Event
Add a Filter with Tooling API
Add a Filter with Metadata API
Subscribe to the Channel and Receive the Filtered Event Stream
Get Custom Channels and Channel Members
Obtain a Platform Event’s Subscribers
Identify and Match Event Messages with the EventUuid Field
Testing Your Platform Event in Apex
Encrypting Platform Event Messages at Rest in the Event Bus
Monitor Platform Event Publishing and Delivery Usage
Considerations
Examples
Reference
PDF

Add a Filter with Tooling API

Before you can add a filter, create a channel. Use PlatformEventChannel in Tooling API, and specify API version 56.0 or later.

User Permissions Needed
To create or update PlatformEventChannel and PlatformEventChannelMember objects: Customize Application
To use REST API: API Enabled

You can use your preferred REST API tool to perform these steps. We recommend using Postman with the Salesforce Platform APIs collection, which contains handy templates for Salesforce API calls. To set up Postman, see Quick Start: Connect Postman to Salesforce in Trailhead.

  1. To create a channel, send a POST request to this URI. 
    /services/data/v63.0/tooling/sobjects/PlatformEventChannel

    If you're using Postman, expand Event Platform | Custom Channels | Platform Event, and click Create channel.

  2. Use this example request body. To have this channel accept platform events, event is specified for channelType. 
    {
  "FullName": "MyChannel__chn",
  "Metadata": {
    "channelType": "event",
    "label": "Custom Channel for Platform Events"
  }
}
    You receive a response similar to this example response.
    {
  "id" : "0YLRM000000004X4AQ",
  "success" : true,
  "errors" : [ ],
  "warnings" : [ ],
  "infos" : [ ]
}
  3. Add a channel member that specifies the custom platform event and filter expression. This example references the custom platform event, Order_Event__e. Send a POST request to this URI. 
    /services/data/v63.0/tooling/sobjects/PlatformEventChannelMember

    If you're using Postman, expand Event Platform | Custom Channels | Platform Event, and click Create channel member.

  4. Use this example request body. 
    {
 "FullName": "MyChannel_chn_Order_Event_e",
 "Metadata": {
  "eventChannel": "MyChannel__chn",
  "filterExpression": "(City__c LIKE 'S%' OR City__c='New York') AND Amount__c>10.50",
  "selectedEntity": "Order_Event__e"
 }
}
    You receive a response similar to this example response.
    {
  "id" : "0v8RM0000000MnNYAU",
  "success" : true,
  "errors" : [ ],
  "warnings" : [ ],
  "infos" : [ ]
}

To update a filter expression, perform a PATCH request to /services/data/v63.0/tooling/sobjects/PlatformEventChannelMember/<ChannelMemberID>, and pass in the entire request body with the new filter expression. You can update only the filterExpression field of a channel member. All other fields aren’t updateable.

If your Salesforce org has a namespace, prepend the namespace prefix to each field used in filterExpression and the selectedEntity value in the PlatformEventChannelMember request body. For example, if the namespace is ns, the request body in this example becomes:
{
  "FullName": "MyChannel_chn_Order_Event_e",
  "Metadata": {
    "eventChannel": "MyChannel__chn",
    "filterExpression": "(ns__City__c LIKE 'S%' OR ns__City__c='New York') AND ns__Amount__c>10.50",
    "selectedEntity": "ns__Order_Event__e"
  }
}