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
Example: Interactive Visualforce Page without Replay
Prerequisites
Step 1: Create an Object
Step 2: Create a PushTopic
Step 3: Create the Static Resources
Step 4: Create a Visualforce Page
Step 5: Test the PushTopic Channel
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

You need access and appropriate permissions to complete the code example.
  • Access to a Developer Edition organization.

    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).

  • The API Enabled permission must be enabled for your Developer Edition organization. This permission is enabled by default, but an admin might have changed it.
  • The Streaming API permission must be enabled. This permission is enabled by default, but an admin might have changed it.
  • The logged-in user must have Read permission on the PushTopic standard object to receive notifications.
  • The logged-in user must have Create permission on the PushTopic standard object to create and manage PushTopic records.
  • The logged-in user must have Author Apex permissions to create a PushTopic by using the Developer Console.