What is a platform event

Platform events are secure and scalable messages that contain data. Publishers publish event messages that subscribers receive in real time. To customize the data published, define platform event fields. Platform events are part of Salesforce’s enterprise messaging platform.

How does a platform event work?

Platform events are secure and scalable messages that contain data. Publishers publish event messages that subscribers receive in real time. To customize the data published, define platform event fields. Platform events are part of Salesforce’s enterprise messaging platform.

What is a platform event message in Salesforce?

Platform events are the event messages (or notifications) that your apps send and receive to take further action. Platform events simplify the process of communicating changes and responding to them without writing complex logic.

What is Salesforce platform event?

Salesforce publishes standard platform events in response to an action that occurred in the org or to report errors. For example, LoginEventStream monitors user login activity and BatchApexErrorEvent reports errors encountered in batch Apex jobs.

What is a 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 trigger a platform event?

The after insert trigger event corresponds to the time after a platform event is published. After an event message is published, the after insert trigger is fired. To create a platform event trigger, use the Developer Console. Click the Setup icon, select Developer Console, and click File | New | Apex Trigger.

How do I publish a platform event?

To publish event messages, call the EventBus. publish method. For example, if you defined a custom platform event called Low Ink , reference this event type as Low_Ink__e . Next, create instances of this event, and then pass them to the Apex method.

How do I view platform events in Salesforce?

View Event Subscribers From Setup, enter Platform Events in the Quick Find box, then select Platform Events. Click your event’s name. On the event’s definition page, the Subscriptions related list shows all the active triggers, processes, and platform event–triggered flows that are subscribed to the platform event.

How do I use platform events in Salesforce?

From Setup, enter Platform Events in the Quick Find box, then select Platform Events.
On the Platform Events page, click New Platform Event.
Create a Notification platform event with the following settings: Label: Notification. Plural Label: Notifications. Object Name: Notification. …
Click Save.

How do I test a platform event in Salesforce?

Event and Event Bus Properties in Test Context. In test context, event messages and the event bus have different properties. …
Deliver Test Event Messages. Deliver test event messages after the Test. …
Test Retried Event Messages.

Article first time published on

How do I create a platform event in Salesforce?

From Setup, enter Platform Events in the Quick Find box, then select Platform Events.
On the Platform Events page, click New Platform Event.
Create a Notification platform event with the following settings: Label: Notification. Plural Label: Notifications. Object Name: Notification. …
Click Save.

How do I create a platform event in Apex?

In Quick Find in the Setup menu, enter “Platform Events.”
Select the Option of Platform Events under Integrations.
Select the New Platform Event button.
Create a Label and Object Name.
Select a Publish Behavior of Publish Immediately.

How do I retrieve a platform event in Salesforce?

Retrieve Platform Events To retrieve all platform events, in addition to custom objects defined in your org, use the wildcard character ( * ) for the <members> element, as follows. To retrieve or deploy triggers associated to a platform event, use the ApexTrigger metadata type.

How do you test a platform event?

Event and Event Bus Properties in Test Context. …
Deliver Test Event Messages. …
Test Retried Event Messages.

How do I create a platform event in 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.

How do I view platform events in workbench?

1. Go to Queries and select Streaming Push Topics. 2. Enter /event/PlatformEvent__e(Use API Name).

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 you create a platform event in 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.

How do I know if a platform event is published in Salesforce?

Use the EventUuid field value to match the status to the event published. If you published the event in Apex, you can obtain the UUID by calling EventBus. getOperationId(saveResult) . If you published the event using Salesforce APIs, the SaveResult returned contains the UUID in the Error message field.

Are platform events synchronous or asynchronous?

High-volume platform events are published asynchronously. With publish status events, you can track the status of publishing operations and take the necessary actions.

Are platform events asynchronous?

Unlike triggers on standard or custom objects, triggers on platform events don’t execute in the same Apex transaction as the one that published the event. The trigger runs asynchronously in its own process. As a result, there can be a delay between when an event is published and when the trigger processes the event.

How do you test a platform event trigger?

Event and Event Bus Properties in Test Context. …
Deliver Test Event Messages. …
Test Retried Event Messages.

How do I subscribe to platform event in lightning component?

Go to setup > Search ‘platform event’ and click on Platform event link. Enter values in required field and click on save. Publish After Commit to have the event message published only after a transaction commits successfully. With this option, a subscriber receives the event message after the data is committed.

What is Apex sharing in Salesforce?

Apex managed sharing enables developers to programmatically manipulate sharing to support their application’s behavior through Apex or the SOAP API. This type of sharing is similar to managed sharing. Only users with “Modify All Data” permission can add or change Apex managed sharing on a record.

Can Salesforce subscribe to external events?

Custom platform event fields are defined in Salesforce and determine the data that you send and receive. Apps can publish and subscribe to platform events on the Lightning Platform or in external systems.

What is CometD Salesforce?

CometD is a scalable HTTP-based event routing bus that uses an AJAX push technology pattern known as Comet. It implements the Bayeux protocol. Long polling, also called Comet programming, allows emulation of an information push from a server to a client.