Platform Events Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Flows
Processes
Lightning Components
Pub/Sub API
CometD
Prerequisite: Define Platform Events
Create a Custom Channel and Add Platform Events with Tooling API
Create a Custom Channel and Add Platform Events with Metadata API
Subscribe to the Channel
List Custom Channels and Channel Members
Identify and Match Event Messages with the EventUuid Field
Monitor Platform Event Publishing and Delivery Usage
Newer Version Available
Create a Custom Channel and Channel Members Using the API
Let’s walk through the steps to create a channel and add two platform events via channel
members. Then, you can subscribe to the channel to validate receiving event messages for platform
events.
-
Prerequisite: Define Platform Events
The custom channel examples depend on a predefined custom platform events called Order_NorthAmer__e and Order_EMEA__e. Before creating the custom channel, define these events in Salesforce. -
Create a Custom Channel and Add Platform Events with Tooling API
In this example, you create a channel for orders named Order_Channel__chn, and you add two platform events as members: Order_NorthAmer__e and Order_EMEA__e. -
Create a Custom Channel and Add Platform Events with Metadata API
You can use Metadata API to create a channel and channel member. We recommend using Metadata API as part of the application lifecycle management process to develop, test, deploy, and release your apps to production. If you want to only configure the channel, we recommend using Tooling API with REST.