Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Example: Subscribe to and Replay Events Using a Java Client (EMP Connector)
Prerequisites
Step 1: Create an Object
Step 2: Create a PushTopic (Legacy)
Step 3: Download and Build the Project
Step 4: Use the Connector with Username and Password Login
(Optional) Step 5: Use the Connector with OAuth Bearer Token Login
Learn More About EMP Connector
Example: Subscribe to and Replay Events Using a Lightning Component
Example: Interactive Visualforce Page without Replay
Example: Authentication
Client Connection Considerations
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.

Step 2: Create a PushTopic (Legacy)

Create a PushTopic in the Developer Console. Event notifications are generated for updates that match the query.

PushTopic events is a legacy product. Salesforce no longer enhances PushTopic events with new features and provides limited support for this product. Instead of PushTopic events, consider using Change Data Capture events. To subscribe to change events, see Java Quick Start for Pub/Sub API in the Pub/Sub API Guide. To learn about Change Data Capture, see the Change Data Capture Developer Guide and the Change Data Capture Basics Trailhead module.

Important

  1. Open the Developer Console.
  2. Click Debug | Open Execute Anonymous Window.
  3. In the Enter Apex Code window, paste in the following Apex code, and click Execute. 
    1PushTopic pushTopic = new PushTopic();
2pushTopic.Name = 'InvoiceStatementUpdates';
3pushTopic.Query = 'SELECT Id, Name, Status__c, Description__c FROM Invoice_Statement__c';
4pushTopic.ApiVersion = 67.0;
5pushTopic.NotifyForOperationCreate = true;
6pushTopic.NotifyForOperationUpdate = true;
7pushTopic.NotifyForOperationUndelete = true;
8pushTopic.NotifyForOperationDelete = true;
9pushTopic.NotifyForFields = 'Referenced';
10insert pushTopic;

    If your organization has a namespace prefix defined, then you’ll need to preface the custom object and field names with that namespace when you define the PushTopic query. For example, SELECT Id, Name, namespace__Status__c, namespace__Description__c FROM namespace__Invoice_Statement__c.

    Note

    Because NotifyForOperationCreate, NotifyForOperationUpdate, NotifyForOperationDelete and NotifyForOperationUndelete are set to true, Streaming API evaluates records that are created, updated, deleted, or undeleted and generates a notification if the record matches the PushTopic query. Because NotifyForFields is set to Referenced, Streaming API will use fields in both the SELECT clause and the WHERE clause to generate a notification. Whenever the fields Name, Status__c, or Description__c are updated, a notification will be generated on this channel. For more information about NotifyForOperationCreate, NotifyForOperationUpdate, NotifyForOperationDelete, NotifyForOperationUndelete, and NotifyForFields, see Event Notification Rules.

    In API version 28.0 and earlier, notifications are only generated when records are created or updated. The NotifyForOperationCreate, NotifyForOperationUpdate, NotifyForOperationDelete, and NotifyForOperationUndelete fields are unavailable and the NotifyForOperations enum field is used instead to set which record events generate a notification. For more information see PushTopic.

    Note