Salesforce Platform Events Pub/Sub (Early Access) connector
Use the Salesforce Platform Events Pub/Sub (Early Access) connector to receive Salesforce Platform Events and Change Data Capture (CDC) events in processes. The connector uses the Salesforce Pub/Sub API, which is built on gRPC, to subscribe to event channels and create one output document for each event it receives.
The Salesforce Platform Events Pub/Sub (Early Access) connector is in Public Early Access. The Listen operation is the only action available in this release. For the standard Salesforce Platform Events connector, which supports Listen and Send, refer to Salesforce Platform Events connector.
Connector configuration
To use the connector, set up two components:
- Salesforce Platform Events Pub/Sub (Early Access) connection. Defines the Pub/Sub API host and port, and the OAuth 2.0 settings the connector uses to authenticate with Salesforce. The connector supports the Authorization Code, Client Credentials, and JWT Bearer grant types.
- Salesforce Platform Events Pub/Sub (Early Access) operation (Listen). Defines the event channel to subscribe to and where event delivery starts.
After you build the connection and operation, configure the connector within a process. The Listen operation is available only on the Start step of a process.
Supported authentication schemes
- OAuth 2.0 Authorization Code
- OAuth 2.0 JWT Bearer
- OAuth 2.0 Client Credentials
Prerequisites
- A Salesforce org with Platform Events or Change Data Capture enabled for the events you want to receive.
- A Salesforce Connected App for the grant type you use. For JWT Bearer, upload the certificate that matches the private key to the Connected App and pre-authorize the Salesforce user in the Connected App.
- Outbound network access from the runtime to the Pub/Sub API host (default
api.pubsub.salesforce.com) on port 7443 or 443.
Limitations
- The Listen operation is the only action supported in this release.
- Test connection does not verify subscribe permissions. Confirm that the Salesforce user or Connected App can subscribe to the target channel.
- Salesforce enforces a concurrent-stream ceiling of 1,000 for the Pub/Sub API. Plan the number of listeners accordingly. See Pub/Sub API and Event Allocations.
- The Listen operation runs as a singleton listener by default. The setting cannot be changed. In a runtime cloud, enable a listener worker.
Tracked properties
Listen exposes the following tracked properties:
| Property | Description |
|---|---|
channel | Salesforce topic that delivered the event. |
eventId | Salesforce event identifier. Use it to de-duplicate redelivered events. |
replayId | Base64-encoded Salesforce replay position for the event. |
schemaId | Salesforce schema identifier used to decode the event. |
