Salesforce
This page contains the setup guide and reference information for the Salesforce source connector.
Prerequisites
- Salesforce Account with Enterprise access or API quota purchased
- (Optional, Recommended) Dedicated Salesforce user
- (For Airbyte Open Source) Salesforce OAuth credentials
To use this connector, you'll need at least the Enterprise edition of Salesforce or the Professional Edition with API access purchased as an add-on. Reference the Salesforce docs about API access for more information.
Setup guide
Step 1: (Optional, Recommended) Create a read-only Salesforce user
While you can set up the Salesforce connector using any Salesforce user with read permission, we recommend creating a dedicated read-only user for Airbyte. This allows you to granularly control the data Airbyte can read.
To create a dedicated read only Salesforce user:
- Log in to Salesforce with an admin account.
- On the top right of the screen, click the gear icon and then click Setup.
- In the left navigation bar, under Administration, click Users > Profiles. The Profiles page is displayed. Click New profile.
- For Existing Profile, select Read only. For Profile Name, enter Airbyte Read Only User.
- Click Save. The Profiles page is displayed. Click Edit.
- Scroll down to the Standard Object Permissions and Custom Object Permissions and enable the Read checkbox for objects that you want to replicate via Airbyte.
- Scroll to the top and click Save.
- On the left side, under Administration, click Users > Users. The All Users page is displayed. Click New User.
- Fill out the required fields:
- For License, select Salesforce.
- For Profile, select Airbyte Read Only User.
- For Email, make sure to use an email address that you can access.
- Click Save.
- Copy the Username and keep it accessible.
- Log into the email you used above and verify your new Salesforce account user. You'll need to set a password as part of this process. Keep this password accessible.
For Airbyte Open Source: Obtain Salesforce OAuth credentials
If you are using Airbyte Open Source, you will need to obtain the following OAuth credentials to authenticate:
- Client ID
- Client Secret
- Refresh Token
To obtain these credentials, follow this walkthrough with the following modifications:
- If your Salesforce URL is not in the
X.salesforce.com
format, use your Salesforce domain name. For example, if your Salesforce URL isawesomecompany.force.com
then use that instead ofawesomecompany.salesforce.com
. - When running a curl command, run it with the
-L
option to follow any redirects. - If you created a read-only user, use the user credentials when logging in to generate OAuth tokens.
Step 2: Set up the Salesforce connector in Airbyte
For Airbyte Cloud:
- Log in to your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + New source.
- Find and select Salesforce from the list of available sources.
- Enter a Source name of your choosing to help you identify this source.
- To authenticate: For Airbyte Cloud: Click Authenticate your account to authorize your Salesforce account. Airbyte will authenticate the Salesforce account you are already logged in to. Please make sure you are logged into the right account.
- Toggle whether your Salesforce account is a Sandbox account or a production account.
- (Optional) For Start Date, use the provided datepicker or enter the date programmatically in either
YYYY-MM-DD
orYYYY-MM-DDTHH:MM:SSZ
format. The data added on and after this date will be replicated. If this field is left blank, Airbyte will replicate the data for the last two years by default. Please note that timestamps are in UTC. - (Optional) In the Filter Salesforce Object section, you may choose to target specific data for replication. To do so, click Add, then select the relevant criteria from the Search criteria dropdown. For Search value, add the search terms relevant to you. You may add multiple filters. If no filters are specified, Airbyte will replicate all data.
- Click Set up source and wait for the tests to complete.
For Airbyte Open Source:
- Navigate to your Airbyte Open Source dashboard.
- In the left navigation bar, click Sources. In the top-right corner, click + New source.
- Find and select Salesforce from the list of available sources.
- Enter a Source name of your choosing to help you identify this source.
- To authenticate: For Airbyte Open Source: Enter your Client ID, Client Secret, and Refresh Token.
- Toggle whether your Salesforce account is a Sandbox account or a production account.
- (Optional) For Start Date, use the provided datepicker or enter the date programmatically in either
YYYY-MM-DD
orYYYY-MM-DDTHH:MM:SSZ
format. The data added on and after this date will be replicated. If this field is left blank, Airbyte will replicate the data for the last two years by default. Please note that timestamps are in UTC. - (Optional) In the Filter Salesforce Object section, you may choose to target specific data for replication. To do so, click Add, then select the relevant criteria from the Search criteria dropdown. For Search value, add the search terms relevant to you. You may add multiple filters. If no filters are specified, Airbyte will replicate all data.
- Click Set up source and wait for the tests to complete.