Streaming API Developer Guide

Getting Started with Streaming API
Push Technology
Bayeux Protocol, CometD, and Long Polling
Streaming API Terms
How the Client Connects
Message Reliability
Message Durability
Streaming Event Features
Streaming API vs. Pub/Sub API
Differences Between Change Events Received with Streaming API vs. Pub/Sub API
API End-of-Life Policy
Code Examples
Client Connection Considerations
PushTopic Events (Legacy)
Generic Events (Legacy)
Monitoring Event Usage
PDF

Newer Version Available

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

API End-of-Life Policy

Check out the policy for retiring API versions, and which Streaming API versions are supported, deprecated, or retired.

Salesforce is committed to supporting each API version for a minimum of 3 years from the date of first release. To improve the quality and performance of the API, versions that are over 3 years old sometimes are no longer supported.

Salesforce notifies customers who use an API version scheduled for deprecation at least 1 year before support for the version ends.

Streaming API Versions Version Support Status Version Retirement Info
Versions 37.0 through 61.0 Supported.
Versions 23.0 through 36.0 Streaming API was introduced in API version 23.0. As of Winter ’24, versions 23.0 through 36.0 are deprecated and no longer supported by Salesforce.

Starting in Winter ’25, these versions will be retired and unavailable.

 Streaming API Versions 23.0 through 36.0 Retirement

After Streaming API versions are retired, clients that connect using the retired API versions receive an “Unsupported API version” error (error code 400).