Salesforce Inbound Endpoint Reference¶
The following configurations allow you to configure Salesforce Inbound Endpoint for your scenario.
| Parameter | Description | Required | Possible Values | Default Value |
|---|---|---|---|---|
| sequential | Whether the messages should be polled and injected sequentially. | Yes | true , false | TRUE |
| replay | Enabling this will read the event ID stored in the Registry DB or from the text file stored in the local machine. | Yes | enable or disable | false |
| packageVersion | The version of the Salesforce API. | Yes | 37.0 | - |
| salesforceObject | The name of the Push Topic or the Platform Event that is added to the Salesforce account. | Yes | /topic/Account | - |
| authenticationType | The authentication method to use when connecting to Salesforce. username-token uses SOAP login with a username, password and security token. oauth uses the OAuth2 Client Credentials grant type. Configurations without this parameter default to username-token. OAuth2 Client Credentials support is available from inbound version 2.1.17 onwards. |
No | username-token, oauth | username-token |
| loginEndpoint | The SOAP login endpoint for the Salesforce account. Required only when authenticationType is username-token. |
Yes (when authenticationType = username-token) | https://login.salesforce.com | https://login.salesforce.com |
| userName | The username for accessing the Salesforce account. Required only when authenticationType is username-token. |
Yes (when authenticationType = username-token) | - | - |
| password | The password provided here is a concatenation of the user password and the security token provided by Salesforce. Required only when authenticationType is username-token. For more information, see Information on creating a security token in Salesforce. |
Yes (when authenticationType = username-token) | eitest123xxxxxxx | - |
| clientId | The OAuth2 consumer key from the Salesforce Connected App. Required only when authenticationType is oauth. |
Yes (when authenticationType = oauth) | - | - |
| clientSecret | The OAuth2 consumer secret from the Salesforce Connected App. Required only when authenticationType is oauth. |
Yes (when authenticationType = oauth) | - | - |
| tokenEndpoint | The OAuth2 token endpoint URL. Use https://test.salesforce.com/services/oauth2/token for sandbox environments. Applicable only when authenticationType is oauth. |
No (when authenticationType = oauth) | https://login.salesforce.com/services/oauth2/token | https://login.salesforce.com/services/oauth2/token |
| waitTime | The time to wait to connect to the Salesforce account. | Yes | 5000 | 5 * 1000 ms |
| connectionTimeout | The time to wait to connect to the client. | Yes | 20000 | 20 * 1000 ms |
| soapApiVersion | The version of the Salesforce SOAP API. | Yes | 22.0 | - | 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 EventIDStoredFilePath is not configured, and the value of this parameter (initialEventId) is greater than the replayId stored in the registry. |
No | 100 | -1 | 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 |
| EventIDStoredFilePath | When replay is enabled, do not define any value for this property (i.e., keep it blank), to replay from the last event ID stored in the config Registry DB (property- name of the Salesforce object (follow the example below for more understanding) resource path - connector/salesforce/event). When replay is enabled, specify the directory path of a text file to start replaying from the event ID stored in it. | No | /home/kasun/Documents/SalesForceConnector/a.txt | - |