You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: airbyte-integrations/connectors/source-salesforce/source_salesforce/spec.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
"properties": {
10
10
"is_sandbox": {
11
11
"title": "Sandbox",
12
-
"description": "Whether the app is in a Salesforce sandbox or not. If you do not know what this is, assume it as false. We provide more info on this field in the <a href=\"https://docs.airbyte.com/integrations/sources/salesforce#is_sandbox\">docs</a>.",
12
+
"description": "Whether the app is in a Salesforce sandbox or not. If you do not know what this is, assume it as false. We provide more info on this field in the <a href=\"https://docs.airbyte.com/integrations/sources/salesforce#sandbox-accounts\">docs</a>.",
Copy file name to clipboardExpand all lines: docs/integrations/sources/salesforce.md
+43-10Lines changed: 43 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,7 @@ The connector uses as much rate limit as it can every day, then ends the sync ea
25
25
Note that, picking up from where it ends will work only for incremental sync.
26
26
27
27
## Getting Started (Airbyte Cloud)
28
+
28
29
#### Sandbox accounts
29
30
30
31
If you log in using at [https://login.salesforce.com](https://login.salesforce.com), then your account is not a sandbox. If you log in at [https://test.salesforce.com](https://test.salesforce.com) then it's a sandbox.
@@ -33,48 +34,79 @@ If this is Greek to you, then you are likely not using a sandbox account.
33
34
34
35
### Requirements
35
36
36
-
* Salesforce Account
37
+
* Salesforce Account with Enterprise access or API quota purchased
37
38
* Dedicated Salesforce user (optional)
38
39
39
-
**Note**: In order to tightly scope Airbyte's access to your data, we recommend creating a dedicated read-only Salesforce user that is used for Airbyte syncs. You can also further the user's (and therefore Airbyte's) access to only the data and streams you need Airbyte to replicate by creating a profile in Salesforce and assigning it to the user.
40
-
41
40
### Setup guide
42
41
42
+
#### Creating a dedicated read only Salesforce user
43
+
While you can setup the Salesforce connector using any user which has read permissions to your account, we recommend creating a dedicated, read-only user for use with Airbyte. This allows you to granularly control the data Airbyte can read.
44
+
45
+
To create a dedicated read only Salesforce user:
46
+
1. Login to Salesforce with an admin account
47
+
2. On the top right side of the screen, click the "setup" gear icon then click "Setup"
48
+
3. Under the "Administration" section on the left side of the screen, click "Users" > "Profiles"
49
+
4. Click the "new profile" button
50
+
5. Select "Read only" as the value of the "Existing Profile" field, and `Airbyte Read Only User` (or whatever name you prefer) as the profile name
51
+
6. click "Save". This should take you to the profiles page.
52
+
7. Click "edit"
53
+
8. Scroll down to the "Standard Object Permissions" and "Custom Object Permissions" and enable the "read" checkbox for objects which you would to be able to replicate via Airbyte
54
+
9. Scroll to the top and click "Save"
55
+
10. Under the "Administration" section on the left side of the screen, click "Users" > "Users".
56
+
11. Click "New User"
57
+
12. Fill out the required fields
58
+
a. In the "License" field, select `Salesforce`
59
+
b. In the "Profile" field, select `Airbyte Read Only User`
60
+
c. In the "Email" field, make sure to use an email address which you can access (this will be required later to verify the account)
61
+
13. Click "save"
62
+
14. Copy the "Username" field and keep it handy -- you will use it when setting up Airbyte later
63
+
15. Login to the email you set in step 12c above and verify your new Salesforce account user. You'll need to set a password as part of this process. Keep this password handy.
64
+
16. With the username and password, you should be ready to setup the Salesforce connector.
65
+
66
+
#### Configuring the connector in the Airbyte UI
43
67
1. Toggle whether your Salesforce account is a Sandbox account or a live account.
44
68
2. Click `Authenticate your Salesforce account` to sign in with Salesforce and authorize your account.
45
69
3. Fill in the rest of the details.
46
70
4. You should be ready to sync data.
47
71
48
72
## Getting started (Airbyte OSS)
49
73
### Requirements
50
-
* Salesforce Account
51
-
* Salesforce OAuth credentials
52
-
* Dedicated Salesforce user (optional)
53
-
54
-
**Note**: In order to tightly scope Airbyte's access to your data, we recommend creating a dedicated read-only Salesforce user that is used for Airbyte syncs. You can also further the user's (and therefore Airbyte's) access to only the data and streams you need Airbyte to replicate by creating a profile in Salesforce and assigning it to the user.
74
+
* Salesforce Account with Enterprise access or API quota purchased
75
+
* Dedicated read only Salesforce user (optional)
76
+
* Salesforce OAuth credentials
55
77
56
78
### Setup guide
57
79
58
80
#### Sandbox accounts
59
81
If you log in using at [https://login.salesforce.com](https://login.salesforce.com), then your account is not a sandbox. If you log in at [https://test.salesforce.com](https://test.salesforce.com) then it's a sandbox.
60
82
61
83
If this is Greek to you, then you are likely not using a sandbox account.
84
+
85
+
### Setup guide
86
+
87
+
#### Read only user
88
+
See the [section above](#creating-a-dedicated-read-only-salesforce-user) for creating a read only user. This step is optional.
89
+
90
+
#### Salesforce Oauth Credentials
62
91
We recommend the following [walkthrough](https://medium.com/@bpmmendis94/obtain-access-refresh-tokens-from-salesforce-rest-api-a324fe4ccd9b)**while keeping in mind the edits we suggest below** for setting up a Salesforce app that can pull data from Salesforce and locating the credentials you need to provide to Airbyte.
63
92
64
93
Suggested edits:
65
94
66
95
1. If your salesforce URL does not take the form `X.salesforce.com`, use your actual Salesforce domain name. For example, if your Salesforce URL is `awesomecompany.force.com` then use that instead of `awesomecompany.salesforce.com`.
67
96
2. When running a `curl` command, always run it with the `-L` option to follow any redirects.
97
+
3. If you created a read only user, use those credentials when logging in to generate oauth tokens
68
98
69
99
## Streams
70
100
71
-
**Note**: The connector supports reading both standard streams and Custom Objects from Salesforce.
101
+
**Note**: The connector supports reading both Standard Objects and Custom Objects from Salesforce. Each object is read as a separate stream.
102
+
103
+
See a list of all Salesforce Standard Objects [here](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_list.htm).
72
104
73
105
We fetch and handle all the possible & available streams dynamically based on:
74
106
- User Role & Permissions to read & fetch objects and their data
75
107
- Whether or not the stream has the queryable property set to true. Queryable streams are available to be fetched via the API. If you cannot see your object available via Airbyte, please ensure it is API-accessible to the user you used for authenticating into Airbyte
76
108
77
-
**Note**: Using the BULK API is not possible to receive data from the following streams:
109
+
**Note**: Using the BULK API is not possible to receive data from the following streams due to limitations from the Salesforce API. The connector will sync them via the REST API whcih will occasionally cost more of your API quota:
78
110
79
111
* AcceptedEventRelation
80
112
* AssetTokenEvent
@@ -100,6 +132,7 @@ We fetch and handle all the possible & available streams dynamically based on:
0 commit comments