Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Client Connection Considerations
PushTopic Events (Legacy)
Working with PushTopics
PushTopic Queries
Event Notification Rules
Replay PushTopic Streaming Events
Filtered Subscriptions
Bulk Subscriptions
Deactivating a Push Topic
PushTopic Considerations
PushTopic Streaming Allocations
Reference: PushTopic
Generic Events (Legacy)
Monitoring Event Usage
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Working with PushTopics

Each PushTopic record that you create corresponds to a channel in CometD. The channel name is the name of the PushTopic prefixed with “/topic/”, for example, /topic/MyPushTopic. A Bayeux client can receive streamed events on this channel. The channel name is case-sensitive when you subscribe.

As soon as a PushTopic record is created, the system starts evaluating record creates, updates, deletes, and undeletes for matches. Whenever there’s a match, a new notification is generated. The server polls for new notifications for currently subscribed channels every second. This frequency can fluctuate depending on the overall server load.

  • Record changes that Bulk API performs don’t generate notifications because a large volume of changes can flood a channel. Also, changes made by tools that use Bulk API, such as the Mass Transfer tool or Data Loader, don’t generate notifications.
  • Cascade-deleted records don't trigger PushTopic notifications. To receive notifications for cascade-deleted records, use Change Data Capture instead. For more information, see Change Data Capture Developer Guide.

Note

The PushTopic defines when notifications are generated in the channel. Specify the conditions in these PushTopic fields:

To receive notifications, users must have read access on the object in the PushTopic query and the PushTopic itself.

PushTopic isn’t available for users in Experience Cloud sites, including Partner Community and Customer Community users. Also, PushTopic isn’t available in legacy Customer Portals.

Note