PushTopic Events

Streaming API enables streaming of events using push technology and provides a subscription mechanism for receiving events in near real time. The Streaming API subscription mechanism supports multiple types of events, including PushTopic events, generic events, platform events, and Change Data Capture events.

PushTopic Events

PushTopic events provide a secure and scalable way to receive notifications for changes to Salesforce data that match a SOQL query you define.

Use PushTopic events to:

  • Receive notifications of Salesforce record changes, including create, update, delete, and undelete operations.

  • Capture changes for the fields and records that match a SOQL query.

  • Receive change notifications for only the records a user has access to based on sharing rules.

  • Limit the stream of events to only those events that match a subscription filter.

Creating a Push Topic

Go to https://workbench.developerforce.com/. Select either Production or Sandbox depending on which environment your Salesforce organisation is in. Click Login with Salesforce. Make sure that you log in with the same Salesforce account for the Salesforce organisation that you are setting up with the integration.

Go to data > Insert. For Object Type, select PushTopic. Select Single Record. Click Next.

For the PushTopic field values enter:

Click Confirm Insert.

Streaming a Push Topic

In Workbench, go to queries > Streaming Push Topics. From the Push Topic menu, select the name of the Push Topic that you created. Click Subscribe.

Last updated