Platform Events Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
Platform Event Processing at Scale with Parallel Subscriptions for Apex Triggers
Order of Events in Parallel Subscriptions
Choosing a Partition Key
Parallel Subscription Limits
Parallel Subscription Configuration Examples in Tooling API and Metadata API
Apex Trigger Repartitioning
Configure Parallel Subscriptions for an Apex Trigger
Testing an Apex Trigger Configured with Parallel Subscriptions
Parallel Subscriptions Considerations
Configure the User and Batch Size for Your Platform Event Trigger with PlatformEventSubscriberConfig
Find Uncaught Exceptions in Event Log Files
Resume a Platform Event Trigger After an Uncaught Exception
Retry Event Triggers with EventBus.RetryableException
Email Notifications for Triggers in Error State
Comparing setResumeCheckpoint() and EventBus.RetryableException
Lightning Components
Pub/Sub API
CometD
Group Your Event Streams
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

Parallel Subscription Configuration Examples in Tooling API and Metadata API

Configure parallel subscriptions for an Apex trigger by using PlatformEventSubscriberConfig in Tooling API or Metadata API.

Each PlatformEventSubscriberConfig corresponds to one Apex trigger subscriber. To configure parallel subscriptions, use these fields in PlatformEventSubscriberConfig: NumPartitions and PartitionKey.

  • The NumPartitions field is the number of parallel subscriptions, or partitions, that are created internally for an Apex trigger. It can be a number from 1 through 10.
  • The PartitionKey field value is hashed. Based on the generated hash value, the system determines which partition to send the event to. PartitionKey can be the standard EventUuid field or a required custom field of the platform event that the Apex trigger subscribes to. For the standard EventUuid field, the partition key format is the field name without the event name: EventUuid. For a custom field, the partition key includes the event name as a prefix in this format: EventName__e.FieldName__c.

Example: Tooling API Request for the EventUuid Partition Key Field

This example shows the body of a REST request for PlatformEventSubscriberConfig in Tooling API. It specifies the EventUuid partition key and three partitions. PlatformEventConsumerId references the ID of the Apex trigger.

{
    "DeveloperName":"MyOrderEventTriggerConfig",
    "MasterLabel":"MyOrderEventTriggerConfig",
    "PlatformEventConsumerId": "Apex_Trigger_Id",
    "PartitionKey": "EventUuid",
    "NumPartitions": "3"
}

Example: Tooling API Request for a Custom Partition Key Field

This example shows the body of a REST request for PlatformEventSubscriberConfig in Tooling API. It specifies the name of a custom event field in PartitionKey and three partitions. PlatformEventConsumerId references the ID of the Apex trigger.

{
    "DeveloperName":"MyOrderEventTriggerConfig",
    "MasterLabel":"MyOrderEventTriggerConfig",
    "PlatformEventConsumerId": "Apex_Trigger_Id",
    "PartitionKey": "Order_Event__e.Order_Number__c",
    "NumPartitions": "3"
}

Example: Metadata API for the EventUuid Partition Key Field

This example shows the definition of PlatformEventSubscriberConfig in Metadata API for the EventUuid standard field specified in partitionKey and three partitions specified in numPartitions. The platformEventConsumer field is the name of the Apex trigger.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventSubscriberConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel>MyOrderEventTriggerConfig</masterLabel>
    <platformEventConsumer>MyOrderEventTrigger</platformEventConsumer>
    <numPartitions>3</numPartitions>
    <partitionKey>EventUuid</partitionKey>
</PlatformEventSubscriberConfig>

This package.xml manifest file references the PlatformEventSubscriberConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <name>PlatformEventSubscriberConfig</name>
        <members>MyOrderEventTriggerConfig</members>
    </types>
    <version>62.0</version>
</Package>

Example: Metadata API for a Custom Partition Key Field

This example shows the definition of PlatformEventSubscriberConfig in Metadata API for the Order_Number__c custom field that is specified in partitionKey and three partitions specified in numPartitions. The platformEventConsumer field is the name of the Apex trigger.

<?xml version="1.0" encoding="UTF-8"?>
<PlatformEventSubscriberConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <masterLabel>MyOrderEventTriggerConfig</masterLabel>
    <platformEventConsumer>MyOrderEventTrigger</platformEventConsumer>
    <numPartitions>3</numPartitions>
    <partitionKey>Order_Event__e.Order_Number__c</partitionKey>
</PlatformEventSubscriberConfig>

This package.xml manifest file references the PlatformEventSubscriberConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <name>PlatformEventSubscriberConfig</name>
        <members>MyOrderEventTriggerConfig</members>
    </types>
    <version>62.0</version>
</Package>