How to use platform events in salesforce


  • Platform events are special kinds of entity similar to custom object
  • You can publish and consume platform events by using Apex or a REST API or SOAP API.
  • Platform events integrate with the Salesforce platform through Apex triggers. …
  • Unlike custom objects, you can’t update or delete event records. …

More items…


What are the different platforms in Salesforce?

With that, here are the tools you can use to build apps on Lightning Platform:

  • Salesforce Environments. A secure and isolated development environment for developers and admins to test ideas, accelerate app development, and customize the platform. …
  • Heroku. It lets you extend Salesforce by building engaging experiences through custom apps. …
  • mySalesforce. …
  • myEinstein. …
  • Salesforce App Cloud. …

How to subscribe to Salesforce platform event?

Subscribe Channel Listener. Step 1: Add Salesforce Subscribe channel listener and configure as shown below: Step 2: Log the actual platform event which will be in the Object format like below: The sample event would look like: Step 3: Now add Transform message to extract the event message that is encapsulated in the above Object.

How to create your first app in Salesforce?

  • To create application in lightning, Click File | New | Lightning Application.
  • Enter the name, and click Ok. E.g. resource. You may set name accordingly.
  • Now use c:helloWorld to refer the component helloWorld.cmp using the default namespace c. If your organization has a registered namespace, you can use it to reference. …

What is a platform event?

Platform events are the event messages that your apps send and receive. They simplify the process of communicating changes and responding to them without requiring you to write complex logic. Publishers and subscribers communicate with each other through platform events. One or more subscribers can listen to the same event and carry out actions.


What are platform events used for in Salesforce?

Use platform events to connect business processes in Salesforce and external apps through the exchange of real-time event data. Platform events are secure and scalable messages that contain data. Publishers publish event messages that subscribers receive in real time.

How do you use a platform event?

Below are the several ways to receive the platform event:Subscribe to Platform Event Messages with Flows.Subscribe to Platform Event Messages with Processes.Subscribe to Platform Event Notifications with Apex Triggers.Subscribe to Platform Event Notifications in a Lightning Component.More items…•

How do I consume a platform event in Salesforce?

Subscribe to Platform Event Notifications with Apex TriggersClick the Setup icon, select Developer Console, and click File | New | Apex Trigger.Provide a name and choose your event for the sObject, and click Submit.

How do I add a platform event record in Salesforce?

Setting up the Platform Event We need to create a custom platform event within Salesforce and add fields to that event. You will recognize this process as it mimics many of the steps in creating a custom object, custom metadata, or custom setting. In Quick Find in the Setup menu, enter “Platform Events.”

How do I test a platform event in Salesforce?

Add Apex tests to test platform event subscribers. Before you can package or deploy Apex code, including triggers, to production, it must have tests and sufficient code coverage….Testing Your Platform Event in ApexEvent and Event Bus Properties in Test Context. … Deliver Test Event Messages. … Test Retried Event Messages.

How do I publish a platform event in Salesforce using flow?

Go to Setup à Enter and choose Flows. Click on New Flow and choose Platform Event-Triggered Flow. Choose respective Platform event object to subscribe in the Start element. Drag and drop Create record element and capture the published Platform event field values with the respective Salesforce object.

What is platform event flow in Salesforce?

Platform Events in Salesforce Platform Event is based on Event-Driven Architecture which enable apps to communicate inside and outside of Salesforce. Platform events are based on the publish/subscribe model and work directly with a message bus which handles the queue of incoming events and processes listening for them.

What is platform event in process builder?

Processes built in Process Builder can subscribe to platform events and receive event messages published through Apex, APIs, flows, and other processes. Processes provide an autosubscription mechanism. To subscribe a process to a platform event, build the process to start when it receives a platform event message.

How do you write a test class for a platform event?

Use Test. startTest() and Test. stopTest() to test your platform event in Apex. Create test event objects, and publish them after the Test….So the fairly standard pattern.Call Test.startTest()Publish the event.Call Test.stopTest()Assert the expected outcome of your trigger.

Can we query platform events?

For platform events, you can query usage data for these metrics. The first value is the metric name value that you supply in the query. For change data capture events, you can query usage data for these metrics. The first value is the metric name value that you supply in the query.

How do I publish a platform event?

Publish Platform Event with Flow Navigate to Setup > Process Automation > Flows select New Flow and then Record-Triggered Flow . Use the Freeform to create the new Flow. Select Opportunity as Object and define A record is created as the trigger before we continue. Create a Salesforce Flow to publish a Platform Event.

How do I publish a platform event using process builder?

Use Process Builder to publish event messages from a Salesforce app as part of an automated process. To publish event messages, add a Create a Record action to the appropriate process. Where you’d usually pick an object to create, select the custom platform event.

What is platform event in Salesforce?

Platform events enable the flow of event messages within Salesforce and to or from external apps. Apps on the Salesforce platform use an Apex method to publish events and an Apex trigger or the empApi Lightning component to consume events. As an alternative to code, you can publish events with declarative tools, such as Process Builder and Flow Builder. External apps publish events using the sObject API and consume events using CometD. As you can see, there is a lot of flexibility in how you choose to use Platform Events!

What is platform event?

Platform events are similar to generic events but offer more powerful customization. With platform events, you can publish any custom data. You define the schema of event data at a granular level as typed fields. Also, you can use platform events in native Salesforce platform apps and external apps alike.

What is a trigger in Salesforce?

The external system publishes a platform event to alert Salesforce to the merchandise return. An event listener (a trigger) in Salesforce receives the event and performs some actions. For example, the trigger might alert the sales representative to the return, and send a confirmation email to the customer.

What happens when an opportunity closes in Salesforce?

When an opportunity closes in Salesforce, your company has won a deal with a customer. Let’s say you use vendors to ship products associated with an opportunity. Each vendor has an external app that processes shipment orders. The external app listens to platform events. When an opportunity closes, a trigger, which is part of a product order app in Salesforce, fires and publishes a platform event message. Each vendor app is notified of the event and creates a shipment order for a specific product.

What is an event in business?

Event. A change in state that is meaningful in a business process. For example, placement of a purchase order is a meaningful event, because the order fulfillment center expects to receive a notification before processing an order. Event message. A message that contains data about the event.

What is event based communication?

Event-based communication takes place in real-time—or, more accurately, in near-real time. Radio waves travel at the speed of light, but event-based software and hardware systems typically have some latencies.

Can consumers receive and react to the same events?

Any number of consumers can receive and react to the same events. When an event occurs, systems obtain this information and can react to it in near-real time. Systems that send events and others that receive the events don’t have dependencies on each other, except for the semantics of the message content.


To publish a platform event message using REST API, send a POST request to the following endpoint.


If you’ve defined a platform event named Low Ink, publish event notifications by inserting Low_Ink__e data. This example creates one event of type Low_Ink__e in REST API.

REST API Composite Resource

To publish multiple platform event messages in one REST API request, use the composite resource. Send a POST request to the following endpoint.


This composite request contains two platform events in the request body.


To publish a platform event message using SOAP API, use the create () call.


This example shows the SOAP message (using Partner API) of a request to create three platform event messages in one call. Each event has one custom field named Printer_Model__c.

Understanding Platform Events using Real-Time Business use case -Salesforce

Each program will take care of its own notifications process. They should be having the processes to send notifications whenever new data arrives. For this, we can have triggers written or maybe some Process builder setup on each program to send notifications.

But, How will a platform event get to know that there is an event?

The EventBus.publish (something) is quite similar to “insert” operation in Salesforce DML operations. So as soon as an “insert” has happened, respective object’s trigger comes into picture.


Types of Platform Events

  • 1. Standard PE
    These are the predefined events provided by Salesforce itself. Some examples of Standard PE are: 1. AssetTokenEvent: Monitors OAuth 2.0 authentication activity. 2. BatchApexErrorEvent: Reports error encountered in batch apexjobs.

See more on

Publishing Platform Events

  • Below are several ways to publish a platform event after defining the same: 1. Publish Event Messages with Flows 2. Publish Event Messages with Processes 3. Publish Event Messages with Apex 4. Publish Event Messages via APIs Below is the code snippet to publish platform event with Apex:

See more on

Subscribing Platform Events

  • Below are the several ways to receive the platform event: 1. Subscribe to Platform Event Messages with Flows 2. Subscribe to Platform Event Messages with Processes 3. Subscribe to Platform Event Notifications with Apex Triggers 4. Subscribe to Platform Event Notifications in a Lightning Component 5. Subscribe to Platform Event Notifications with CometD(Workbench)

See more on


  • We hope you find this post helpful and will guide you to define, publish, and subscribe to platform events. To know more, don’t hesitate to connect with us. Emizentech, a Salesforce development company, is always there to serve you the best.

See more on

Leave a Comment