To increase your event delivery allocation for Pub/Sub API, CometD, empApi Lightning components, and event relays, purchase an add-on for additional platform events. The add-on moves your event delivery usage to a monthly usage-based entitlement model and allows for spikes in usage. To purchase an add-on, contact your Salesforce Account Representative.
Check out the benefits and facts about an add-on license.
- The add-on increases the 24-hour allocation of delivered event messages by 100,000 per day (3 million a month) as a usage-based entitlement.
- The add-on increases the hourly event publishing allocation by 25,000 events per hour.
- The daily delivery usage isn’t as strictly enforced as the default allocation. The add-on allows for spikes in usage through a grace allocation. The grace allocation is higher than the allocation that you purchased through the add-on license. As long as the daily event delivery usage is within the grace allocation, your subscribers aren’t stopped and can continue receiving events. Salesforce reserves the right to adjust grace allocations at any time.
- 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.
Table 1. Example: Usage-Based Entitlement with One High-Volume Platform Event Add-On License
|
Description
|
Subscriber Clients
|
Performance and Unlimited Editions
|
Enterprise Edition and Professional Edition (with API Add-On)
|
|
Event Delivery: entitlement for delivered event messages, shared by all clients.
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.
|
This entitlement applies to:
Pub/Sub API
CometD
empApi
Lightning component
Event relays
This allocation doesn’t apply to:
Apex triggers
Flows
Process Builder processes
|
Last 24 hours: 150,000 (50 K included with org license + 100 K from add-on license + grace amount)
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 + grace amount)
Monthly entitlement: 3.75 million (0.75 million included with org license + 3 million from add-on license)
|
|
Event Publishing: maximum number of event messages published per hour.
|
This allocation applies to all publishing methods, including:
Apex
Pub/Sub API
REST API
SOAP API
Bulk API
Flows
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)
|
j