Platform Events Developer Guide

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
Create a Custom Channel for Custom Platform Events Using the API
Prerequisite: Define Platform Events
Create a Custom Channel and Add Platform Events with Tooling API
Metadata API Example: Create a Custom Channel and Add Platform Events
Subscribe to the Channel
Create a Custom Channel for Real-Time Event Monitoring Events Using the API
List Custom Channels and Channel Members
Filter Your Event Streams
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

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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.
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 NorthAmer
    2. Plural Label: Order NorthAmer
    3. Select Starts with a vowel sound, if available.
    4. Click Save.
  4. Create four fields. In Custom Fields & Relationships, click New for each field, and follow the wizard.
    1. Field type: Text; Field Label: Order Number; Length: 10
    2. Field type: Text; Field Label: City; Length: 50
    3. Field type: Number; Field Label: Amount; Length: 16; Decimal Places: 2
  5. Repeat these steps for a platform event with the label Order EMEA and the same fields.