Key | Description | Sample value |
---|---|---|
api_type | The api_type is used to switch the behavior of the tap between using Salesforce’s “REST” and “BULK” APIs. When new fields are discovered in Salesforce objects, the select_fields_by_default key describes whether or not the tap will select those fields by default. | REST , BULK |
domain | Your Salesforce instance domain. Use ‘login’ (default) or ‘test’ (sandbox), or Salesforce My domain. | test , login |
select_fields_by_default | If true , the fields in a schema of a stream will all be selected by default when setting up a synchronization. | true , false |
start_date | The start_date is used by the tap as a bound on SOQL queries when searching for records. This should be this exact format YYYY-mm-ddTHH:MM:SSZ . | 2022-11-30T21:31:20Z |
OAuth
based authentication:
Key | Description | Sample value |
---|---|---|
client_id | OAuth Salesforce App secrets. | ABC1... |
client_secret | OAuth Salesforce App secrets. | ABC1... |
refresh_token | The refresh_token is a secret created during the OAuth flow | ABC1... |
Password
based authentication:
Key | Description | Sample value |
---|---|---|
username | Salesforce account username | ABC1... |
password | Salesforce account password | ABC1... |
security_token | Salesforce account security token | ABC1... |
Key | Description | Sample value |
---|---|---|
threshold | When running INCREMENTAL sync runs, threshold is used to throttle how often STATE messages are generated (in REST api_type).This can be useful to minimize the amount of STATE messages being generated. | Defaults to 1000 |
streams | List of stream names to be discovered inside the salesforce tap. if none is given, the tap will search for all avaliable streams, which can take several minutes. | [“Account”] |
client_id
, client_secret
, and refresh_token
client_id
and client_secret
api
)refresh_token
)client_id
) and Consumer Secret (which is your client_secret
).https://[your_salesforce_domain].my.salesforce.com/services/oauth2/authorize?client_id=[client_id]&redirect_uri=https://login.salesforce.com/services/oauth2/success&response_type=code
Variable | Description | Sample value |
---|---|---|
[your_salesforce_domain] | The domain of your Salesforce account. | mage-dev-ed |
[client_id] | Your Consumer Key | ABC123... |
https://login.salesforce.com/services/oauth2/success?code=[code]
.code
URL parameter, it’ll be used to get a refresh_token
.refresh_token
URL parameter | Description | Sample value |
---|---|---|
[your_salesforce_domain] | The domain of your Salesforce account. | mage-dev-ed |
[code] | The code you received after authorizing your Connected App | ABC123... |
[client_id] | Your Consumer Key | ABC123... |
[client_secret] | Your Consumer Secret | ABC1... |
refresh_token
, it’ll be used when you configure this source.