Platform Events Developer Guide
jNewer Version Available
Platform Event Allocations
Which Events Do Allocations Apply to?
Platform events can be custom events, which are platform events that you define, or standard events, which are the events that Salesforce defines, including Real-Time Event Monitoring events. Platform event allocations, including the event publishing and delivery allocations and common allocations, apply to custom events.
For standard events, the event publishing allocation isn’t enforced. To find out whether the event delivery allocation applies, check the event reference documentation in Standard Platform Event Object List. The event delivery allocation doesn’t apply to Real-Time Event Monitoring events. When allocations aren’t enforced, system protection limits apply. Common platform event allocations, such as the number of concurrent clients, apply to all events.
How Is Event Usage Calculated?
To learn how event usage is calculated against your event allocations, see Learn About Daily Rate Limits in the App Development Without Limits Trailhead module.
Common Platform Event Allocations
These 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 Process Builder processes and flows that can subscribe to a platform event | 4,000 | 4,000 | 4,000 | 5 |
| Maximum number of active Process Builder processes and flows that can subscribe to a platform event | 2,000 | 2,000 | 2,000 | 5 |
| Maximum number of custom channels that can be created This allocation is separate from the one for custom change data capture channels. |
100 | 100 | 100 | 100 |
| Maximum number of distinct platform events that can be added to a channel as part of
channel members If the same platform event is added to multiple channels, it’s counted once toward the allocation. |
50 | 50 | 5 | 5 |
High-Volume Platform Event Default Allocations
If your org has no add-on licenses, default allocations apply for event publishing and delivery that can’t be exceeded. The default allocation is enforced daily to ensure fair sharing of resources in the multitenant environment and to protect the service. The publishing allocation is how many events you can publish using any method, including Apex, Pub/Sub API and other APIs, flows, and processes. The delivery allocation is how many event notifications can be delivered to CometD and Pub/Sub API subscribers, empApi Lightning components, and event relays. It excludes non-API subscribers, such as Apex triggers, flows, and Process Builder processes. The publishing allocation is higher than the delivery allocation because there can be various types of subscribers. Published event messages that are delivered to non-API subscribers, such as Apex triggers, flows, and Process Builder processes, don’t count against the delivery allocation.
The number of delivered events to clients is counted for each subscribed client, including event relays. If you have multiple client subscribers, your usage is added across all subscribers. For example, you have an Unlimited Edition org with a default allocation of 50,000 events in a 24-hour period. Within a few hours, 20,000 event messages are delivered to two subscribed clients. So you consumed 40,000 events and are still entitled to 10,000 events within the 24-hour period.
If you exceed the default event delivery allocation, an error is returned and the subscription is disconnected. The event delivery limit is a rolling limit. Usage for the last 24 hours is checked when a new event message is received. The client can resubscribe and receive events after usage decreases. The error you receive in a CometD client is: 403::Organization total events daily limit exceeded. The error is returned in the Bayeux /meta/connect channel when a CometD subscriber first connects or in an existing subscriber connection. For more information, see Streaming API Error Codes in the Streaming API Developer Guide. The error code that you receive in a Pub/Sub API client is: sfdc.platform.eventbus.grpc.subscription.limit.exceeded. And the error message is: You have exceeded the event delivery limit for your org. Event messages that are generated after exceeding the allocation, as well as earlier event messages, are stored in the event bus. You can retrieve stored event messages as long as they are within the retention window of 72 hours.
Salesforce Order Management has its own allocation for high volume process events. The allocation provides 100 delivered events per Salesforce Order Management license that you purchase.
| Description | Performance and Unlimited Editions | Enterprise Edition and Professional Edition (with API Add-On) | Developer Edition |
|---|---|---|---|
| Event Delivery: maximum number of delivered event notifications in the last 24 hours, shared by all clients. (Applies to CometD and Pub/Sub API clients, empApi Lightning components, and event relays only.) | 50,000 | 25,000 | 10,000 |
| Event Delivery for Salesforce Order Management: maximum number of delivered event notifications in the last 24 hours, shared by all clients. (Applies to CometD and Pub/Sub API clients, empApi Lightning components, and event relays only.) | 100 | 100 | 100 |
| Event Publishing: maximum number of event notifications published per hour. (Applies to all publishing methods, including Apex, Pub/Sub API and other APIs, flows, and Process Builder processes.) | 250,000 | 250,000 | 50,000 |
High-Volume Platform Event Add-On License and Usage-Based Entitlement
If your org has the add-on license, your allocation for delivered events to CometD and Pub/Sub API clients, empApi Lightning components, and event relays moves to a monthly entitlement model. The add-on increases the 24-hour allocation of delivered event notifications by 100,000 per day (3 million a month) as a usage-based entitlement. The entitlement gives you flexibility in how you use your allocations. The entitlement isn’t as strictly enforced as the default allocation. With the entitlement, you can exceed your 24-hour event delivery allocation by a certain amount. The entitlement is reset every month after your contract start date. Entitlement usage is computed only for production orgs. It isn’t available in sandbox or trial orgs. For more information, see Usage-based Entitlement Fields.
Salesforce monitors event overages based on a calendar month, starting with your contract start date. If you exceed the monthly entitlement, Salesforce contacts you to discuss your event usage needs. The entitlement used for monitoring monthly event overages is the daily allocation multiplied by 30.
When you purchase an add-on license, the hourly event publishing allocation increases by 25,000 events per hour.
| Description | Performance and Unlimited Editions | Enterprise Edition and Professional Edition (with API Add-On) |
|---|---|---|
| Event Delivery: entitlement for delivered
event notifications, shared by all clients. (Applies to CometD and
Pub/Sub API clients, empApi
Lightning components, and event relays only.) You can exceed this entitlement by a certain amount before receiving an error. Salesforce uses the monthly entitlement for event overage monitoring. The monthly entitlement is returned in the limits REST API resource. |
Last 24 hours: 150,000
(50 K included with org license + 100 K from add-on
license) Monthly entitlement: 4.5 million (1.5 million included with org license + 3 million from add-on license) |
Last 24 hours: 125,000
(25 K included with org license + 100 K from add-on
license) Monthly entitlement: 3.75 million (0.75 million included with org license + 3 million from add-on license) |
| Event Publishing: maximum number of event notifications published per hour. (Applies to all publishing methods, including Apex, Pub/Sub API and other APIs, flows, and Process Builder processes.) | 275,000 (250 K included with org license + 25 K from add-on license) | 275,000 (250 K included with org license + 25 K from add-on license) |
The maximum event message size that you can publish is 1 MB. If your event object has hundreds of custom fields or many long text area fields, you can hit this limit. In this case, the publishing call gets an error.
Monitor Your High-Volume Event Usage Against Your Allocations
Check your event publishing and delivery usage in the user interface. From Setup, in the Quick Find box, enter Platform Events, and then select Platform Events. The usage is shown in the Event Allocations section.
If your org purchased the add-on for additional platform events, the monthly event delivery usage is also displayed in the Event Allocations section. This usage corresponds to the MonthlyPlatformEvents REST limits value.
Learn about other ways to check event usage with REST API, Apex, and in the Company Information page.
| Allocation | Default Allocations | Add-On License |
|---|---|---|
| Event Delivery: number of delivered event notifications to CometD and Pub/Sub API clients, empApi Lightning components, and event relays | If your org hasn’t purchased the add-on, get the event delivery usage in the last 24 hours by checking the DailyDeliveredPlatformEvents value with the REST API limits resource. Or in Apex, use the System.OrgLimit class and check the DailyDeliveredPlatformEvents value. This value is updated within a few minutes after event delivery. | If your org has purchased the add-on, check your usage in one of these ways.
|
| Event Publishing: number of event notifications published per hour | With the REST API limits resource: usage information is returned in HourlyPublishedPlatformEvents. | With the REST API limits resource: usage information is returned in HourlyPublishedPlatformEvents. |
For more information about the limit usage values that the limits REST resource returns, see Limits and List Org Limits in the REST API Developer Guide. For more information about the Apex OrgLimit class, see OrgLimit Class in the Apex Reference Guide.
Monitor 24-Hour and Daily Event Usage with PlatformEventUsageMetric
To get usage data for event publishing for any publishing method and API client delivery for CometD, Pub/Sub API, the empApi Lightning component, and event relays, query the PlatformEventUsageMetric object. PlatformEventUsageMetric contains actual event usage data broken down by type of event for high-volume platform events and change data capture events. The usage metrics stored in PlatformEventUsageMetric are separate from the REST API limits values. The REST API limits resource returns the maximum and remaining allocations for platform events and change data capture events.
PlatformEventUsageMetric usage data is available for the last 24 hours, ending at the last hour, and for historical daily usage for the last 45 days. Use PlatformEventUsageMetric to get visibility into your usage trends.
For more information, see Monitor Platform Event Publishing and Delivery Usage.
Monitor Hourly Event Delivery Usage with REST API
To monitor your org’s high-volume platform event and change event delivery hourly usage, make a REST API call to the limits resource every hour. The difference between the results obtained in the last 2 hours shows how many events were delivered in the last hour.
For example, you make a call at 12:00 PM and see that you have 40,000 events remaining. Then you run the same call at 1:00 PM and see that you have 38,500 events remaining. The returned responses indicate that 1,500 events were delivered to your API subscribers between 12:00 PM and 1:00 PM.
These results are examples of the responses that a GET request to the /services/data/v60.0/limits URI returns.
1First call result:
2{
3...
4 "DailyDeliveredPlatformEvents" : {
5 "Max" : 50000,
6 "Remaining" : 40000
7 },
8
9...
10}
11
12Second call result:
13{
14...
15 "DailyDeliveredPlatformEvents" : {
16 "Max" : 50000,
17 "Remaining" : 38500
18 },
19
20...
21}Standard-Volume Platform Event Allocations
These allocations are for standard-volume events defined in API version 44.0 and earlier.
| Description | Performance and Unlimited Editions | Enterprise Edition | Developer Edition and Professional Edition (with API Add-On) |
|---|---|---|---|
| Event Delivery: maximum number of delivered event notifications in the last 24 hours, shared by all CometD clients1 | 50,000 | 25,000 | 10,000 |
| Event Publishing: maximum number of event notifications published per hour | 100,000 | 100,000 | 1,000 |
If you exceed the event delivery allocation, you receive this error: 403::Organization total events daily limit exceeded. The error is returned in the Bayeux /meta/connect channel when a CometD subscriber first connects or in an existing subscriber connection. For more information, see Streaming API Error Codes in the Streaming API Developer Guide. Standard-volume event messages that are generated after exceeding the allocation are stored in the event bus. You can retrieve stored standard-volume event messages as long as they are within the retention window of 24 hours.
To monitor your standard-volume event delivery usage, use the limits REST API resource, and inspect the DailyStandardVolumePlatformEvents value. And to monitor the publishing usage, inspect the HourlyPublishedStandardVolumePlatformEvents value. For more information, see List Organization Limits in the REST API Developer Guide.
1To request a higher number of standard-volume 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.