Platform Events Developer Guide

Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Platform Event
Publishing Platform Events
Subscribing to Platform Events
Testing Your Platform Event in Apex
Considerations
Examples
Reference
Platform Event Allocations
EventBusSubscriber
EventBus Class
TriggerContext Class
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Platform Event Allocations

Learn about the allocations available for platform event definitions, publishing and subscribing to platform events, and event delivery in CometD clients.

Common Platform Event Allocations

The following allocations apply to standard-volume and high-volume platform events.

Description Performance and Unlimited Editions Enterprise Edition Developer Edition Professional Edition (with API Add-On)
Maximum number of platform event definitions that can be created in an org 100 50 5 5
Maximum number of concurrent CometD clients (subscribers) across all channels and for all event types 2,000 1,000 20 20
Maximum number of processes that can subscribe to a platform event 4,000 4,000 4,000 5
Maximum number of active processes that can subscribe to a platform event 2,000 2,000 2,000 5
  • The concurrent client allocation is shared with all types of events that you can subscribe to through Streaming API, including PushTopic, generic, and Change Data Capture events.
  • Platform events that originate from an installed managed package share the org’s allocation for the maximum number of platform event definitions.

Note

Standard-Volume Platform Event Allocations

Description Performance and Unlimited Editions Enterprise Edition Developer Edition and Professional Edition (with API Add-On)
Maximum number of delivered event notifications within a 24-hour period, shared by all CometD clients1 50,000 25,000 10,000
Maximum number of event notifications published per hour 100,000 100,000 1,000

1To request a higher number of events delivered to CometD clients, contact Salesforce to purchase an add-on license. The add-on license increases your daily limit of delivered events by 100,000 more events. For example, for Unlimited Edition, the add-on license increases the daily limit of delivered events from 50,000 to 150,000 events. You can purchase multiple add-ons to meet your event requirements for CometD clients. To avoid deployment problems and degradation in service, we recommend that the number of events delivered to CometD clients not exceed 5 million per day. If you require more external events, contact your Salesforce representative to understand how the product can scale to meet your needs.

High-Volume Usage-Based Entitlements

Each Salesforce edition provides a default allocation for the number of high-volume events delivered to CometD clients. The default allocation is enforced daily to ensure fair sharing of resources in the multitenant environment and to protect the service.

You can purchase an add-on license to increase your daily CometD event delivery allocation. With the add-on license, the CometD event delivery allocation depends on your monthly entitlement and scales with it. With the add-on, you can exceed the daily-equivalent allocation of the monthly entitlement by a certain amount for a 24-hour period. Event overages are calculated for a calendar month, starting with the first day of the month or your contract start date.

When you purchase an add-on license, the hourly event publishing allocation is increased by 25,000 events per month. To purchase more events, contact Salesforce.

The number of delivered events to external CometD clients is counted per subscribed client. If you have multiple client subscribers, your usage is added across all subscribers. For example, if you have an entitlement of three million monthly events, and one million events were delivered to two clients, you used up two million events, and you are still entitled to one million events for the month.

Table 1. Default Allocations
Description Performance and Unlimited Editions Enterprise Edition and Professional Edition (with API Add-On) Developer Edition
Maximum number of delivered event notifications within a 24-hour period, shared by all CometD clients 50,000 25,000 10,000
Maximum number of event notifications published per hour 250,000 250,000 50,000
Table 2. Example: Entitlement with One Add-On License for Three Million Events per Month
Description Performance and Unlimited Editions Enterprise Edition and Professional Edition (with API Add-On)
Maximum number of delivered event notifications within a calendar month, shared by all CometD clients 4.5 million 3.75 million
Maximum number of event notifications published per hour 275,000 275,000

The maximum event message size that you can publish is 1 MB.

Subscribers on the Lightning Platform (non-CometD clients, including Apex triggers, processes, and flows) don’t count against the 24-hour CometD event delivery limit. The number of event messages that an Apex trigger, process, or flow can process depends on how long the processing takes for each subscriber. The longer the processing time, the longer it takes for the subscriber to reach the tip of the event stream.

Note

Monitor Your High-Volume Event Usage

To monitor your monthly event delivery usage, use the limits REST API resource, and inspect the MonthlyPlatformEvents value. The limits resource returns the monthly maximum allocation. If you don’t have an add-on license, your daily default maximum allocation is the monthly allocation returned divided by 30. For more information, see List Organization Limits in the REST API Developer Guide.