Streaming API Developer Guide

Getting Started with Streaming API
Streaming API
Push Technology
Bayeux Protocol, CometD, and Long Polling
Streaming API Terms
How the Client Connects
Message Reliability
Message Durability
Streaming Event Features
Code Examples
Client Connection Considerations
PushTopic Events
Generic Events
Monitoring Event Usage
PDF

Newer Version Available

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

Streaming API

Streaming API enables streaming of events using push technology and provides a subscription mechanism for receiving events in near real time. The Streaming API subscription mechanism supports multiple types of events, including PushTopic events, generic events, platform events, and Change Data Capture events.

Consider the following applications for Streaming API.

Applications That Poll Frequently
Applications that have constant polling action against the Salesforce infrastructure, consuming unnecessary API calls and processing time, would benefit from Streaming API because it reduces the number of requests that return no data.
General Notification
Use Streaming API for applications that require general notification of data changes in an org to reduce the number of API calls and improve performance.

You can use Streaming API with any Salesforce org as long as you enable the API. To ensure continuity during instance refreshes and org migrations, we recommend using your org’s My Domain instead of its instance in the Streaming API endpoint.

Note