Salesforce Inbound Endpoint Reference¶
The Salesforce Inbound Endpoint in WSO2 Micro Integrator is built on top of the Salesforce EMP (Event Monitoring Platform) Connector, which leverages Salesforce’s Streaming API to subscribe to real-time events. This includes support for PushTopics and Change Data Capture (CDC), allowing your integration to respond immediately to changes in Salesforce data—such as when a record is created, updated, deleted, or undeleted.
This reference page documents all the configuration parameters supported by the Salesforce Inbound Endpoint. These parameters control how the connector authenticates with Salesforce, what data it listens to, the polling behavior, event replay settings, and more. Use this table as a guide when configuring your inbound endpoint to ensure seamless and reliable integration with Salesforce's event stream.
| Parameter | Description | Required | Example Values | Default Value |
|---|---|---|---|---|
interval |
The polling interval for the Salesforce inbound endpoint. | Yes | - | - |
connection.salesforce.salesforceObject |
The name of the Push Topic or the Platform Event that is added to the Salesforce account, or the Record the you want to listen for Change Data Capture events. | Yes | /topic/Account/data/AccountChangeEvent |
- |
connection.salesforce.packageVersion |
The version of the Salesforce API. | Yes | 37.0 |
- |
connection.salesforce.userName |
Salesforce login user name. | Yes | - | - |
connection.salesforce.password |
Salesforce login password. | Yes | eitest123xxxxxxx |
- |
connection.salesforce.loginEndpoint |
The Endpoint of the Salesforce account. | Yes | https://login.salesforce.com |
https://login.salesforce.com |
connection.salesforce.soapApiVersion |
The version of the Salesforce SOAP API. | No | 22.0 |
22.0 |
connection.salesforce.connectionTimeout |
The time to wait to connect to the client. | No | 20000 |
20000 |
connection.salesforce.waitTime |
The time to wait to connect to the Salesforce account. | No | 5000 |
5000 |
connection.salesforce.initialEventId |
Specifies the initial event ID from which to start reading messages. This value is applicable only when message replaying is enabled. It will be used only if connection.salesforce.EventIDStoredFilePath is not configured, and the value of this parameter(initialEventId) is greater than the replay ID stored in the registry.
|
No | 100 |
-1 |
connection.salesforce.replay |
Enabling this will read the event ID stored in the Registry or from the text file provided via the event ID file path. | No | - | False |
connection.salesforce.replayWithMultipleInbounds |
This parameter is applicable only when replay is enabled. If you are using multiple Salesforce inbound endpoints, enabling this configuration ensures proper message replay across all endpoints. | No | - | False |
connection.salesforce.EventIDStoredFilePath |
This field is visible only if replay is enabled. When enabled, specify the directory path of a text file to replay from the event ID stored in it, or leave it blank to replay from the last event ID stored in the config Registry DB. | No | /home/kasun/Documents/SalesForceConnector/a.txt |
- |