Salesforce · AsyncAPI Specification

Salesforce Streaming API

Version 44.0

The Salesforce Streaming API uses a publish-subscribe model based on Bayeux/CometD to push near-real-time event notifications to subscribed clients. It supports PushTopic events (triggered by SOQL queries on record changes) and Generic Streaming events (custom notifications). Clients connect via long-polling over HTTPS to receive events as they occur.

View Spec View on GitHub AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSalesAsyncAPIWebhooksEvents

Channels

/topic/{pushTopicName}

subscribe receivePushTopicEvent

Receive a PushTopic record change event

Channel for subscribing to a PushTopic that monitors SOQL-defined record changes. Receives events when records matching the PushTopic query are created, updated, deleted, or undeleted in Salesforce.

/u/{streamingChannelName}

subscribe receiveGenericStreamingEvent

Receive a generic streaming event

Channel for subscribing to a Generic Streaming channel. Receives custom events published to this channel by Salesforce Apex or REST API calls.

Messages

✉

PushTopicEvent

Salesforce PushTopic Record Change Event

Notification of a Salesforce record change matching a PushTopic query

✉

GenericStreamingEvent

Salesforce Generic Streaming Event

Custom event published to a Generic Streaming channel

Servers

https

salesforce https://{instanceName}.salesforce.com/cometd/{apiVersion}

Salesforce CometD streaming endpoint