Configure the Salesforce Synapse Using User Credentials Authentication

Dave Wilks
Dave Wilks
  • Updated

The Salesforce synapse leverages the Salesforce API to synchronize data between Salesforce objects—including custom objects— and Syncari entities. After activating the synapse, Syncari replicates the Salesforce schema and makes it available within the Syncari Unified Data Model. Use Sync Studio to map Salesforce objects to Syncari entities and Salesforce fields to Syncari fields. To accelerate the setup and configuration of these pipelines, Syncari provides a default mapping for the standard objects and fields in Salesforce.

The steps to authenticate the Salesforce synapse differ depending on your selected authentication method. This topic covers authenticating using user credentials. If you want to authenticate using user credentials, see Configure the Salesforce Synapse Using OAuth 2.0 Authentication.

Note: Syncari recommends connecting the Salesforce Synapse using OAuth 2.0 authentication.
Also, Salesforce User Credentials authentication does not work with Custom Actions. Configure your Salesforce synapse using OAuth 2.0 authentication if you plan on using the Salesforce synapse credentials with a Custom Action.


Requirements & Reference

  • Prior to configuring Syncari with production data, we recommend that you first connect a sandbox or test environment.
  • If your Salesforce security requires you to allowlist an IP address, see Allowlist an IP Address.
  • Your Salesforce edition must have API Access so that Syncari can communicate with it. Check out this Salesforce help article to be sure you have a supported edition.
  • Salesforce API documentation

Supported Synapse Capabilities

  • Schema discovery of standard objects
  • Schema discovery of custom objects
  • Bidirectional sync of standard objects
  • Bidirectional sync of custom objects
  • Schema Sync

Salesforce Setup for User Credential Authentication

To configure the Salesforce synapse using OAuth 2.0 using user credential authentication, you’ll need to know the following information about your user credentials and make sure that you have sufficient permissions.

Keep this information handy. You'll need it to Configure the Salesforce Synapse in Syncari.

Locate the Salesforce Endpoint URL

In Salesforce, select your profile, and then copy the URL under your name.

Note: Use only this URL; when you enter it in Syncari, you’ll need to prepend https://.


Find Your Salesforce Security Token

Salesforce emails your security token to you. If you cannot find your security token, you can reset it. The Salesforce help topic Reset Your Security Token includes detailed steps.

Note: If you've set up any other integrations with an existing token and you request a new one, you will need to update the security token in those integrations.

To reset your security token:

  1. Access the Settings in your profile menu.
  2. Search for “Reset My Security Token” in Quick Find.
  3. Click Reset Security Token.
  4. Check your email for the new security token.

Salesforce Permissions

Syncari needs these permissions to manage Salesforce data:

Salesforce Permissions Reason Required?
Read metadata This allows Syncari to ingest the Salesforce data schema Yes

Edit metadata

This allows an auto-sync of the Salesforce schema with Syncari As needed for Syncari solution

Read data on objects

This allows Syncari to ingest data if Salesforce is being configured as a data source As needed for Syncari solution

Write data on objects

This allows Syncari to write data if Salesforce is being configured as a destination As needed for Syncari solution

Configure the Salesforce Synapse in Syncari

In the previous section, you:

Now, you can configure the Salesforce synapse in Syncari:

  1. In Syncari, open Synapse Studio.
  2. Find Salesforce in the Synapse Library, and drag it to the canvas.
  3. Complete the information in the Configure step:
    • Synapse Name—Enter your own custom name for the synapse.
      Note: Stick to letters and numbers. The name must begin with a letter. The only special characters we allow are spaces, hyphens (-), and underscores (_).
    • Endpoint URL—Enter https:// followed by the Salesforce Endpoint URL you identified in Salesforce Details Needed to Authenticate.
      Note: The URL must be a fully formed URL, so make sure to include https://.
    • Authentication Method—Keep the default User Password Token.
    • Optional: The Sync Rate Limit affects downstream syncs with the synapse. Turn on the Sync Rate Limit if needed to limit the sync rate for updates. You can edit this configuration later if you find you need to manage your downstream syncs.
  4. Click Next.
  5. Complete the Authenticate step using the information from Salesforce Setup for User Credential Authentication.
    • User Name—Enter the user name used to log in to Salesforce.
    • Password—Enter the password.
    • Token—Enter the security token.
  6. Click Authenticate, and then click Next.
    Note: If you receive any error messages after authenticating, click Previous and confirm each of the parameters is configured properly. If the error persists, contact one of our Onboarding and Support team members.
  7. Select Make Synapse Active
    Other options include: 
    • Map Entities in Sync Studio—Syncari takes you to Sync Studio to map the entities before activating the Synapse.
    • Activate and Create Pipelines—We don't recommend using this option except in specific use cases (e.g., this is your first synapse, and you want your schema to match that of the synapse). For synapses with default mappings, Syncari updates the Sync Studio canvas and creates draft pipelines for the Syncari Unified Data Model. Contact one of our Onboarding and Support team members before using this option. salesforce-3finish.jpg
  8. Click Close.

Default Mappings

Download as CSV.


Share this

Was this article helpful?

0 out of 1 found this helpful