Salesforce Platform Events Pub/Sub (Early Access) connection
The Salesforce Platform Events Pub/Sub (Early Access) connection contains the information needed to connect to the Salesforce Pub/Sub API and authenticate with a Salesforce org. If you have multiple orgs or sandboxes, create a separate connection for each one. You can pair one connection with more than one operation.
Connection tab
Pub/Sub API Host - The Salesforce Pub/Sub API host. Default: api.pubsub.salesforce.com. Required.
Pub/Sub API Port - The Salesforce Pub/Sub API port. Usually 7443 or 443. Default: 7443. Required.
Salesforce API Version - The Salesforce REST API version used for object discovery, without the "v" prefix (for example, 59.0). Leave blank to use the highest version the org supports. Optional.
OAuth 2.0 tab
Select a Grant Type to display the fields for that grant type.
Grant Type - Choose one of the following:
- Authorization Code (default) - Use for interactive setup.
- Client Credentials - Use for unattended runtimes.
- JWT Bearer - Use for unattended runtimes that authenticate with a signed certificate.
Authorization Code
Client ID - The Consumer Key of the Salesforce Connected App. Required.
Client Secret - The Consumer Secret of the Salesforce Connected App. Required.
Authorization token URL - The Salesforce authorization endpoint. Default: https://login.salesforce.com/services/oauth2/authorize. Use https://test.salesforce.com for a sandbox, or your My Domain host. Required.
Scope - The OAuth scope to request. Optional.
Authorization parameters - Additional name/value parameters for the authorization endpoint. Optional.
Access token URL - The Salesforce token endpoint. Default: https://login.salesforce.com/services/oauth2/token. The connector derives the identity endpoint host from this URL. Required.
Access token parameters - Additional name/value parameters for the token endpoint. Optional.
Client Credentials
Client ID - The Consumer Key of the Salesforce Connected App. Required.
Client Secret - The Consumer Secret of the Salesforce Connected App. Required.
Scope - The OAuth scope to request. Optional.
Access token URL - The Salesforce token endpoint. Default: https://login.salesforce.com/services/oauth2/token. Required.
Access token parameters - Additional name/value parameters for the token endpoint. Optional.
JWT Bearer
Scope - The OAuth scope to request. Optional.
Access token URL - The Salesforce token endpoint. Default: https://login.salesforce.com/services/oauth2/token. Required.
Access token parameters - Additional name/value parameters for the token endpoint. Optional.
Signature Algorithm - Salesforce accepts RS256 only. Default: SHA256withRSA.
Signature Key - The certificate component that holds the private key. Upload the matching certificate to the Connected App. Required.
Issuer (iss) - The Consumer Key of the Connected App. Required.
Subject (sub) - The Salesforce username to act as. The Connected App must be pre-authorized for this user. Required.
Audience (aud) - Default: https://login.salesforce.com. Use https://test.salesforce.com for a sandbox. Required.
Expiration (exp) - Assertion lifetime in milliseconds. Default: 180000. Salesforce rejects values over 5 minutes. Required.
ID Claim Generator (jti) - Generates the JWT ID claim. Choose NONE (default) or UUID. Optional.
Extended JWT Claims - Additional key/value claims to include in the JWT assertion. Optional.
Test connection
Use Test connection to verify your settings before you save the connection. The connector:
- Resolves the credentials, opens the shared gRPC channel, and confirms that the authorization URL is reachable.
- Invokes the GetTopic RPC method with the topic
/event/__BoomiTestConnection__e. Success and "not found" are both valid results.
Test connection covers the Pub/Sub API Host, Pub/Sub API Port, and OAuth 2.0 tab settings.
Test connection does not verify subscribe permissions. A successful test does not guarantee that the Listen operation can subscribe to a channel.