You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
Streaming API is used to keep external systems in sync with Salesforce and to process busoness logic in an external system in response to data changes in Salesforce.
Salesforce Streaming API:
PushTopic queries support all custom objects. PushTopic queries support the following standard objects:
Standard objects supported throught a pilot program:
// PushTopic lets you subscribe to channel to track changes on accounts whose billins city is SF. PushTopic pushTopic = new OushTopic(); pushTopic.Name = 'AccountUpdate'; pushTopic.Query = 'SELECT Id, Name, Phone FROM Account WHERE BillingCity=\'San Francisco\''; pushTopic.ApiVersion = 37.0; insert pushTopic;
At the minimum, define the PushTopic name, query and API version. Use the default values for the remaining properties. By default, the fields in the SELECT statement field list and WHERE clause are the ones that trigger notifications. Notifications are sent only for the records that match the criteria in the WHERE clause. To change whihch fields trigger notifications, set pushTopic.NotifyForFields to one on these values:
| NotifyForFields Value | Description |
|---|---|
| All | Notifications are generated for all record field changes, provided the evaluated records match the criteria specfied in the WHERE clause. |
| Referenced (Default) | Changes to fields referenced in the SELECT and WHERE clauses are evaluated. Notifications are generated for the evaluated records only if they match the criteria specified in the WHERE clause. |
| Select | Changes to fields referenced in the SELECT clause are evaluated. Notifications are generated for the evaluated records only if they match the criteria specified in the WHERE clause. |
| Where | Changes to the fields referenced in the WHERE clause are evaluated. Notifications are generated for the evaluated records only if they match the criteria specified in the WHERE clause. |
To set notification preference explicitly:
pushTopic.NotifyForOperationCreate = true; pushTopic.NotifyForOperationUpdate = true; pushTopic.NotifyForOperationUndelete = true; pushTopic.NotfiyForOperationDelete = true;
< "clientId": "3e4gr556" "data": < "event": < "createdDate": "2016-09-16T19:45:27.454Z", "replayId": 1, "type": "created" >, "sobject": < "Phone": "(415) 555-1212", "Id": "001D000000KneakIAB", "Name": "Blackbeard" > >, "channel": "/topic/AccountUpdates" >
SELECT comma-separated list of fields> FROM Salesforce object> WHERE filter criteria>
SOQL query example:
SELECT Id, Name, Phone FROM Account WHERE BillingCity='San Francisco' OR BillingCity='New York'
The following requirements apply to PushTopic queries:
As of API version 37.0, Salesforce stores events that match PushTopic queries, even if no one is subscribed to the PushTopic. The events are stored for 24 hours, and you can retrieve them at any time during that window. As of API version 37.0, each event notification contains a field called replayId.
Similar to replaying a video, Streaming API replays the event notifications that were sent by using the replayId field. The value of the replayId field is a number that identifies the event in the stream. The replay ID is unique for the org and channel. When you replay an event, you’re retrieving a stored event from a location in the stored stream. You can either retrieve a stream of events starting after the event specified by a replay ID, or you can retrieve all stored events. Here’s a summary of the replay options we can specify when subscribing to a channel.
The sequence of events when using Streaming API is as follows:
Push technology, also called the publish/subscribe model, transfers information that is initiated from a server to the client. This type of communication is the opposite of pull technology in which a request for information is made from a client to the server.
Streaming API uses the Bayeux protocol and CometD for long polling.
Learn about terms used for Streaming API.
Streaming API uses the HTTP/1.1 request-response model and the Bayeux protocol (CometD implementation). A Bayeux client connects to Streaming API in multiple stages.
As of API version 37.0, Streaming API provides reliable message delivery by enabling you to replay past events. In API version 36.0 and earlier, clients might not receive all messages in some situations.
Salesforce stores events for 24 hours, so you can retrieve stored events during that retention window. The Streaming API event framework decouples event producers from event consumers. A subscriber can retrieve events at any time and isn’t restricted to listening to events at the time they’re sent.