Salesforce | Polytomic Docs

Supports:

✅ Models
✅ Model sync destination
✅ Bulk sync source
✅ Connection Proxy

Connection

Configuration

Name	Type	Description	Required
`connect_mode`	`string`	Authentication method Accepted values: `browser`, `clientcredentials` ↓, `code`, `api`	`required`
`domain`	`string`	Domain The Salesforce instance’s login domain, e.g. acmecorp.my.salesforce.com	`required`
`enable_multicurrency_lookup`	`boolean`	Enable multicurrency source field support If incremental mode for bulk-syncing from Salesforce formula fields is enabled, setting this to true extends support to accurate currency conversions.	`optional`
`enable_tooling`	`boolean`	Enable support for Tooling API If true, expose objects from the Salesforce Tooling API in the Polytomic bulk sync source object list.	`optional`
`enforce_api_limits`	`boolean`	Enforce API limits If true, Polytomic will restrict itself to a fixed daily cap of Salesforce API calls enforced by the number in daily_api_calls. ↓	`optional`
`oauth_refresh_token`	`string`		`optional`

Read-only property	Type	Description
`instance_url_override`	`string`	Instance URL override This URL will be used for API requests instead of the one provided by Salesforce during OAuth.
`username`	`string`	Salesforce user

`connect_mode`

When connect_mode is clientcredentials:

Name	Type	Description	Required
`client_id`	`string`	Client ID	`required`
`client_secret`	`string`	Client secret	`required`

{
  "name": "Salesforce connection",
  "type": "salesforce",
  "configuration": {
    "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
    "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
    "connect_mode": "clientcredentials",
    "domain": "acmecorp.my.salesforce.com",
    "enable_multicurrency_lookup": false,
    "enable_tooling": false,
    "enforce_api_limits": false,
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

`enforce_api_limits`

When enforce_api_limits is true:

Name	Type	Description	Required
`daily_api_calls`	`integer`	Daily call limit The daily Salesforce API call cap that Polytomic should adhere to.	`required`

{
  "name": "Salesforce connection",
  "type": "salesforce",
  "configuration": {
    "connect_mode": "browser",
    "daily_api_calls": 0,
    "domain": "acmecorp.my.salesforce.com",
    "enable_multicurrency_lookup": false,
    "enable_tooling": false,
    "enforce_api_limits": true,
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Example

{
  "name": "Salesforce connection",
  "type": "salesforce",
  "configuration": {
    "connect_mode": "browser",
    "domain": "acmecorp.my.salesforce.com",
    "enable_multicurrency_lookup": false,
    "enable_tooling": false,
    "enforce_api_limits": false,
    "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
  }
}

Model Sync

Source

Configuration

Name	Type	Description	Required
`include_deleted`	`boolean`	Include deleted records	`optional`
`query`	`string`		`optional`
`table`	`string`	Object	`optional`

Example

{
  ...
  "configuration": {
    "include_deleted": false,
    "query": "select Id from Contact",
    "table": "Contact"
  }
}

Target

Salesforce connections may be used as the destination in a model sync. Some destinations support additional configuration.

Lead or Contact

Applies to:

multi:leadOrContact

Configuration

Name	Type	Description	Required
`bulk_batch_size`	`integer`	Bulk batch size	`optional`
`concurrency_mode`	`string`	Concurrency mode Accepted values: `Parallel`, `Serial`	`optional`
`create_records_as`	`string`	Create new records as Accepted values: `Contact`, `Lead`, `ContactIfAccountId`	`required`
`ingestion_api`	`string`	Ingestion API Accepted values: `automatic`, `bulk`, `rest`	`required`
`rest_batch_size`	`integer`	REST batch size	`optional`

Example

{
  ...
  "target": {
      "configuration": {
        "bulk_batch_size": 100,
        "concurrency_mode": "Parallel",
        "create_records_as": "Contact",
        "ingestion_api": "bulk",
        "rest_batch_size": 200
    }
  }
}

Leads

Applies to:

Lead

Configuration

Name	Type	Description	Required
`bulk_batch_size`	`integer`	Bulk batch size	`optional`
`concurrency_mode`	`string`	Concurrency mode Accepted values: `Parallel`, `Serial`	`optional`
`ingestion_api`	`string`	Ingestion API Accepted values: `automatic`, `bulk`, `rest`	`required`
`insert_null_values`	`boolean`	Copy null values	`optional`
`invalid_relationships`	`string`	Records with invalid relationship IDs Accepted values: `error`, `omit_values`, `omit_records`	`required`
`only_sync_different`	`boolean`	Only update if different from Salesforce	`optional`
`rest_batch_size`	`integer`	REST batch size	`optional`
`skip_converted`	`boolean`	Ignore converted and duplicate leads	`optional`

Example

{
  ...
  "target": {
      "configuration": {
        "bulk_batch_size": 100,
        "concurrency_mode": "Parallel",
        "ingestion_api": "bulk",
        "insert_null_values": false,
        "invalid_relationships": "error",
        "only_sync_different": false,
        "rest_batch_size": 200,
        "skip_converted": false
    }
  }
}

Other targets

Configuration

Name	Type	Description	Required
`bulk_batch_size`	`integer`	Bulk batch size	`optional`
`concurrency_mode`	`string`	Concurrency mode Accepted values: `Parallel`, `Serial`	`optional`
`ingestion_api`	`string`	Ingestion API Accepted values: `automatic`, `bulk`, `rest`	`required`
`insert_null_values`	`boolean`	Copy null values	`optional`
`invalid_relationships`	`string`	Records with invalid relationship IDs Accepted values: `error`, `omit_values`, `omit_records`	`required`
`only_sync_different`	`boolean`	Only update if different from Salesforce	`optional`
`rest_batch_size`	`integer`	REST batch size	`optional`
`sort_batches_by`	`string`	Sort batches by	`required`

Example

{
  ...
  "target": {
      "configuration": {
        "bulk_batch_size": 100,
        "concurrency_mode": "Parallel",
        "ingestion_api": "bulk",
        "insert_null_values": false,
        "invalid_relationships": "error",
        "only_sync_different": false,
        "rest_batch_size": 200,
        "sort_batches_by": "AccountId"
    }
  }
}

Bulk Sync

Source

Salesforce connections may be used as a bulk sync source. No additional configuration options are required.

This source supports selective Bulk Sync schedules. You can schedule objects based on their incremental-read support at different frequencies. Check capabilities.supports_selective_modes in Get bulk sync source for your Connection.