Salesforce API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "salesforce",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"authentication_method": "ADVANCED | STANDARD",
"password": "string",
"sync_formula_fields": true,
"base_url": "https://base_url.salesforce.com",
"certificate": "---",
"private_key": "---",
"username": "string",
"schema": "schema_name"
},
"auth": {
"refresh_token": "my_refresh_token",
"client_access": {
"client_secret": "my_client_secret",
"client_id": "my_client_id"
}
}
}
Config parameters
Name | Description |
---|---|
authentication_method | (Optional) Authentication type (default value = STANDARD ) |
password | |
sync_formula_fields | Enable this option to sync formula fields directly (default value = false ) |
base_url | (Optional) The custom Salesforce domain. Make sure that the base_url starts with https:// . |
certificate | Provide content of the .pem certificate (only when authentication_method = ADVANCED ). |
private_key | Provide content of the .key private key (only when authentication_method = ADVANCED ). |
username | |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are four ways to authorize this connector type:
OAuth2.0: By specifying the values for the
client_access
andrefresh_token
parameters in theauth
section and theauthentication_method
as"STANDARD"
in the request.POST https://api.fivetran.com/v1/connections
{ "service": "salesforce", "group_id": "group_id", "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" }, "refresh_token": "my_refresh_token" }, "config": { "authentication_method": "STANDARD" } }
Auth Parameters
Name Description refresh_token
The long-lived Refresh token
along with theclient_id
andclient_secret
parameters carry the information necessary to get a new access token for API resources.client_access
client_access.client_secret
Client Secret
of your Salesforce client application.client_access.client_id
Client ID
of your Salesforce client application.mTLS: By specifying the value for the
client_access
parameter in theauth
section and theauthentication_method
as"ADVANCED"
and the values for thecertificate
,private_key
andbase_url
parameters in the request.POST https://api.fivetran.com/v1/connections
{ "service": "salesforce", "group_id": "group_id", "config": { "certificate": "---", "private_key": "---", "base_url": "https://base_url.salesforce.com", "authentication_method": "ADVANCED" }, "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" } } }
Auth Parameters
Name Description client_access
client_access.client_secret
Client Secret
of your Salesforce client application.client_access.client_id
Client ID
of your Salesforce client application.AWS PrivateLink: By specifying the
networking_method
as"PrivateLink"
and the value for thebase_url
parameter in the request.POST https://api.fivetran.com/v1/connections
{ "service": "salesforce", "group_id": "group_id", "config": { "base_url": "https://base_url.salesforce.com" }, "networking_method": "PrivateLink" }
By using the Connect Card or the Fivetran dashboard.