Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Using Streaming API
Working with PushTopics
PushTopic Queries
Event Notification Rules
Replay PushTopic Streaming Events
Filtered Subscriptions
Bulk Subscriptions
Deactivating a Push Topic
Streaming API Considerations
Generic Streaming
Reference
PDF

Newer Version Available

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

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.

Updates performed by the Bulk API won’t generate notifications, since such updates could flood a channel.

Note

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 time may fluctuate depending on the overall server load.

The PushTopic defines when notifications are generated in the channel. This is specified by configuring the following PushTopic fields:

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

Note