Required Scopes

To configure a Sync for Salesforce, you need to request the following scopes from your Salesforce OAuth application:
  • api
  • refresh_token
  • offline_access
Learn more about configuring scopes for your app in Adding Integrations.

Synced Objects

Salesforce supports the following Synced Objects:

Contacts

Sync Configuration Options

Example
{
    "integration": "salesforce",
    "pipeline": "contacts",
    "configuration": {
        "listViewId": "00B5g00000AWN0qEAH"
    }
}
listViewId
string
A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available contacts from the user’s Salesforce account.

Companies

This Sync will pull Accounts from Salesforce to map to the standard Company schema.

Sync Configuration Options

Example
{
    "integration": "salesforce",
    "pipeline": "companies",
    "configuration": {
        "listViewId": "00B5g00000ABC123EAA"
    }
}
listViewId
string
A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available companies from the user’s Salesforce account.

Deals

This Sync will pull Opportunities from Salesforce to map to the standard Deal schema.

Sync Configuration Options

Example
{
    "integration": "salesforce",
    "pipeline": "deals",
    "configuration": {
        "listViewId": "00B5g00000ABC123EAA"
    }
}
listViewId
string
A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available deals from the user’s Salesforce account.

Custom Objects

Sync Configuration Options

Example
{
    "integration": "salesforce",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "Product_Catalog__c",
        "listViewId": "00B5g00000XYZ789EAA"
    }
}
customObjectName
string
required
The API name of the Salesforce custom object to sync, e.g., Product_Catalog__c.
listViewId
string
A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available records for the custom object from the user’s Salesforce account.