Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Client Connection Considerations
Clients and Timeouts
Clients and Cookies for Streaming API
Supported CometD Versions
Streaming API Calls Blocked by Security Settings
Debugging Streaming API Applications
Handling Streaming API Errors
Streaming API Error Codes
Using an Experience Cloud Site with Streaming API-Based Features
PushTopic Events (Legacy)
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.

Debugging Streaming API Applications

You must be able to see all of the requests and responses to debug Streaming API applications. Because Streaming API applications are stateful, you need to use a proxy tool to debug your application. Use a tool that can report the contents of all requests and results, such as Burp Proxy, Fiddler, or Firebug.

The most common errors include:
  • Browser and JavaScript issues
  • Sending requests out of sequence
  • Malformed requests that don't follow the Bayeux protocol
  • Authorization issues
  • Network or firewall issues with long-lived connections

Using these tools, you can look at the requests, headers, body of the post, as well as the results. If you must contact us for help, be sure to copy and save these elements to assist in troubleshooting.