|
| 1 | +# Salesforce |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +:::info |
| 6 | +Airbyte Enterprise Connectors are a selection of premium connectors available exclusively for Airbyte Self-Managed Enterprise and Airbyte Teams customers. These connectors, built and maintained by the Airbyte team, provide enhanced capabilities and support for critical enterprise systems. To learn more about enterprise connectors, please [talk to our sales team](https://airbyte.com/company/talk-to-sales). |
| 7 | +::: |
| 8 | + |
| 9 | +This page guides you through the process of setting up the [Salesforce](https://www.salesforce.com/) destination connector. |
| 10 | + |
| 11 | +## Prerequisites |
| 12 | + |
| 13 | +- [Salesforce Account](https://login.salesforce.com/) with Enterprise access or API quota purchased |
| 14 | +- (Optional, Recommended) Dedicated Salesforce [user](https://help.salesforce.com/s/articleView?id=adding_new_users.htm&type=5&language=en_US) |
| 15 | + |
| 16 | +:::tip |
| 17 | + |
| 18 | +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](https://help.salesforce.com/s/articleView?id=000385436&type=1) for more information. |
| 19 | + |
| 20 | +::: |
| 21 | + |
| 22 | +## Setup guide |
| 23 | + |
| 24 | +### Set up Salesforce |
| 25 | + |
| 26 | +### Step 1: (Optional, Recommended) Create a dedicated Salesforce user |
| 27 | + |
| 28 | +Follow the instructions below to create a profile and assign custom permission sets to grant the new user the write access needed for data you want to access with Airbyte. |
| 29 | + |
| 30 | +[Log in to Salesforce](https://login.salesforce.com/) with an admin account. |
| 31 | + |
| 32 | +#### 1. Create a new User: |
| 33 | +- On the top right of the screen, click the gear icon and then click **Setup**. |
| 34 | +- In the left navigation bar, under Administration, click **Users** > **Users**. Create a new User, entering details for the user's first name, last name, alias, and email. Filling in the email field will auto-populate the username field and nickname. |
| 35 | + - Leave `role` unspecified |
| 36 | + - Select `Salesforce Platform` for the User License |
| 37 | + - Select `Standard Platform User` for Profile. |
| 38 | + - Decide whether to generate a new password and notify the user. |
| 39 | + - Select `save` |
| 40 | +#### 2. Create a new Permission Set: |
| 41 | +- Using the left navigation bar, select **Users** > **Permission Sets** |
| 42 | +- Click `New` to create a new Permission Set. |
| 43 | +- Give your permission set a descriptive label name (e.g., "Airbyte Data Activation"). The API name will autopopulate based on the label you give the permission set. |
| 44 | +- For licence, leave this set to` –None—` and click `save`. |
| 45 | +- Now that you see the permission set is created, define the permissions via Object Settings. |
| 46 | + - Click "Object Settings." |
| 47 | + - Select the `Object Name` for each object you want the user to have write access to (e.g., Accounts, Contacts, Opportunities). |
| 48 | + - Select “Edit” and check all the object permissions under "Object Permissions" |
| 49 | + - Click `Save` |
| 50 | + - Continue to add permissions for any objects you want Airbyte to have access to. |
| 51 | +#### 3. Assign the Permission Set to the new User |
| 52 | +- From the Permission Sets page, click "Manage Assignments" next to the read-only permission set you just created. |
| 53 | +- Click "Add Assignments." |
| 54 | +- Find and select the user you created in Step 1. |
| 55 | +- Click `Assign` |
| 56 | + |
| 57 | +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. |
| 58 | + |
| 59 | +:::info |
| 60 | +**Profile vs. Permission Set:** Remember that the user's profile will provide their baseline permissions. The permission set adds or restricts permissions on top of that. |
| 61 | +**Object-Level vs. Field-Level Security:** This guide focuses on object-level read-only access. While setting up your permission set, you can stick with object-level security or define more granular controls by scrolling down within each object settings page to select read access for only needed fields. |
| 62 | +::: |
| 63 | + |
| 64 | +### Step 2: Set up the Salesforce connector in Airbyte |
| 65 | + |
| 66 | +<!-- env:cloud --> |
| 67 | + |
| 68 | +## For Airbyte Cloud: |
| 69 | + |
| 70 | +1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account. |
| 71 | +2. Click Destinations and then click + New destination. |
| 72 | +3. On the Set up the source page, select Salesforce from the Source type dropdown. |
| 73 | +4. Enter a name for the Salesforce connector. |
| 74 | +5. To authenticate: |
| 75 | + **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. |
| 76 | +6. Toggle whether your Salesforce account is a [Sandbox account](https://help.salesforce.com/s/articleView?id=sf.deploy_sandboxes_parent.htm&type=5) or a production account. |
| 77 | +7. Create a least one mapping that link a stream to a destination object in Salesforce. |
| 78 | +8. Click **Set up source** and wait for the tests to complete. |
| 79 | + |
| 80 | +<!-- /env:cloud --> |
| 81 | + |
| 82 | +## Changelog |
| 83 | + |
| 84 | +<details> |
| 85 | + <summary>Expand to review</summary> |
| 86 | + |
| 87 | +| Version | Date | Pull Request | Subject | |
| 88 | +|:--------| :--------- | :-------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 89 | +| 0.0.1 | 2025-03-14 | [#82](https://github.com/airbytehq/airbyte-enterprise/pull/82) | Initial release | |
| 90 | + |
| 91 | +</details> |
0 commit comments