Prerequisite: Define a Platform Event

The examples in this section depend on a predefined custom platform event called Order_Event__e. To define this event in Salesforce, complete these steps.

Before You Begin 
Required Editions
Available in: Enterprise, Performance, Unlimited, and Developer Editions
User Permissions Needed
To define a platform event:Customize Application

  1. From Setup, in the Quick Find box, enter Platform Events, and then select Platform Events.

  2. Click New Platform Event.

  3. Provide these values.

    1. Label: Order Event

    2. Plural Label: Order Events

    3. Select Starts with a vowel sound, if available.

    4. Click Save.

  4. Create these fields. In Custom Fields & Relationships, click New for each field, and follow the wizard.

    1. Field type: Text; Field Label: Order Number; Length: 18

    2. Field type: Text; Field Label: City; Length: 50

    3. Field type: Number; Field Label: Amount; Length: 16; Decimal Places: 2

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
Previous Versions