Setup Guide

Set up and configure Salesforce as a destination in RudderStack.

This guide will help you set up Salesforce as a destination in the RudderStack dashboard. It also lists the configuration settings required to correctly send data from the supported sources to Salesforce.

warning

Before you begin:

  • Note that RudderStack does not support dev instances of Salesforce. See FAQ for more information.

  • RudderStack recommends creating a new Salesforce account to protect any confidential information in your existing Salesforce account. However, this is completely optional.

  • Give RudderStack the required API permissions by creating a new user account in your Salesforce dashboard.

    • Go to Setup > Administration Setup > Users > New User and select System Administrator as the profile type.
    • For the above user, make sure the password policy is set to Never expires to avoid event delivery issues due to password expiration. See the Salesforce documentation for more information.
  • Turn off two-factor authentication for your Salesforce account. RudderStack will be unable to authenticate while making requests if 2FA is enabled.

  • Make sure the Salesforce objects are searchable and fields are creatable before sending events. Otherwise, it can result in errors during event transformation or delivery.

Connection compatibility

Destination info
  • Status: Generally Available
  • Supported sources: Android, iOS , Web, Unity, AMP , Cloud, Warehouse, React Native , Flutter, Cordova
  • Refer to it as SALESFORCE_OAUTH in the Integrations object.

Connection modes
SourceCloud modeDevice modeHybrid mode
AMPsupportednot supportednot supported
Androidsupportednot supportednot supported
Cloudsupportednot supportednot supported
Cordovasupportednot supportednot supported
Fluttersupportednot supportednot supported
iOSsupportednot supportednot supported
React Nativesupportednot supportednot supported
Unitysupportednot supportednot supported
Warehousesupportednot supportednot supported
Websupportednot supportednot supported
Supported message types
SourceIdentifyPageTrackScreenGroupAliasRecord
Cloud mode
Supported sourcessupportednot supportednot supportednot supportednot supportednot supportednot supported

Setup

  1. From your RudderStack dashboard, add the source. Then, from the list of destinations, select Salesforce.
  2. Assign a name to your destination and click Next.

Connection settings

SettingDescription
User NameEnter your Salesforce username in this field.

warning
The Salesforce API does not support certain special characters in the username.

For example, if you create a secondary user with the email alex.keener+rudder@domain.com, Salesforce sets the username to that email address by default. However, to work with the Salesforce API you will need to remove the + sign from the username.
PasswordEnter the password associated with the Salesforce account.

info
OAuth 2.0 username-password flow is blocked by default in new orgs to avoid any security risks.

Make sure to toggle on the Allow OAuth Username-Password Flows setting to enable this flow for your organization. See the Salesforce documentation for more information.

Salesforce OAuth flow setting
Security TokenEnter your Salesforce security token. You can find it under Setup > Personal Setup > My Personal Information > Reset My Security Token.
Map Rudder Properties to Salesforce PropertiesThis setting is toggled on by default and lets you map the RudderStack event properties to the corresponding Salesforce fields.
Sandbox modeToggle on this setting if you are using a Sandbox environment for the integration.
Use contact ID for converted leadsToggle on this setting if both the lead and contact field mappings are the same.

FAQ

Which Salesforce Edition should I use to access the API?

Before connecting to the Salesforce API with RudderStack, make sure you are using the right Salesforce edition. You must have either the Enterprise, Unlimited, Developer, or Performance editions to access the API.

Follow this Salesforce help article for more information.

Does RudderStack support dev instances of Salesforce?

No, RudderStack does not support Salesforce dev instances currently.

Note that the dev environments (for example, https://companyabc-dev-ed-develop.lightning.force.com/) are different from Salesforce’s sandbox environments.

How do I check the number of Salesforce API calls left for the day?

To check the number of Salesforce API calls, go to Setup > Administration Setup > Company Profile > Company Information. You should then be able to see a field called API Requests, Last 24 Hours, which contains the number of API calls left for the day.

Next steps



Questions? Contact us by email or on Slack