Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Example: Subscribe to and Replay Events Using a Java Client (EMP Connector)
Example: Subscribe to and Replay Events Using a Lightning Component
Example: Subscribe to and Replay Events Using a Visualforce Page
Prerequisites
Deploy a Sample Project to Your Org
Assign a Permission Set
Durable PushTopic Streaming Sample
Durable Generic Streaming Sample
Replay Events Sample: Code Walkthrough
Example: Interactive Visualforce Page without Replay
Example: Authentication
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

Prerequisites

Set up permissions that are required to run the durable streaming samples.
  • You must have access to a Developer Edition org and have the API Enabled and Streaming API permissions enabled. These permissions are enabled by default in a Developer Edition org, but an admin might have changed them.

    If you are not already a member of the Lightning Platform developer community, go to developer.salesforce.com/signup and follow the instructions for signing up for a Developer Edition organization. Even if you already have Enterprise Edition, Unlimited Edition, or Performance Edition, use Developer Edition for developing, staging, and testing your solutions against sample data to protect your organization’s live data. This is especially true for applications that insert, update, or delete data (as opposed to simply reading data).

  • To receive notifications, the logged-in user must have Read permission on the StreamingChannel standard object.
  • To create and manage notifications, the logged-in user must have Create permission on the StreamingChannel standard object.
  • To save the Apex class, the logged-in user must have the Author Apex permission.
  • To save the Visualforce page, the logged-in user must have the Customize Application permission.