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: docs/integrations/sources/salesforce.md
+38-42
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,6 @@ This page guides you through the process of setting up the Salesforce source con
14
14
15
15
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.
16
16
17
-
18
17
To create a dedicated read only Salesforce user:
19
18
20
19
1.[Log into Salesforce](https://login.salesforce.com/) with an admin account.
@@ -25,12 +24,12 @@ To create a dedicated read only Salesforce user:
25
24
6. 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.
26
25
7. Scroll to the top and click **Save**.
27
26
8. On the left side, under Administration, click **Users** > **Users**. The All Users page is displayed. Click **New User**.
28
-
9. Fill out the required fields:
29
-
1. For License, select **Salesforce**.
30
-
2. For Profile, select **Airbyte Read Only User**.
27
+
9. Fill out the required fields:
28
+
1. For License, select **Salesforce**.
29
+
2. For Profile, select **Airbyte Read Only User**.
31
30
3. For Email, make sure to use an email address that you can access.
32
31
10. Click **Save**.
33
-
11. Copy the Username and keep it accessible.
32
+
11. Copy the Username and keep it accessible.
34
33
12. 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.
35
34
36
35
## Step 2: Set up Salesforce as a Source in Airbyte
@@ -72,20 +71,17 @@ The Salesforce source connector supports the following sync modes:
72
71
**Incremental Deletes Sync**
73
72
<br/>The Salesforce connector retrieves deleted records from Salesforce. For the streams which support it, a deleted record will be marked with the field `isDeleted=true` value.
74
73
75
-
76
74
## Performance considerations
77
75
78
-
The Salesforce connector is restricted by Salesforce’s [Daily Rate Limits](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm). The connector syncs data until it hits the daily rate limit, then ends the sync early with success status, and starts the next sync from where it left off. Note that picking up from where it ends will work only for incremental sync, which is why we recommend using the [Incremental Sync - Deduped History](https://docs.airbyte.com/understanding-airbyte/connections/incremental-deduped-history) sync mode.
79
-
76
+
The Salesforce connector is restricted by Salesforce’s [Daily Rate Limits](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm). The connector syncs data until it hits the daily rate limit, then ends the sync early with success status, and starts the next sync from where it left off. Note that picking up from where it ends will work only for incremental sync, which is why we recommend using the [Incremental Sync - Deduped History](https://docs.airbyte.com/understanding-airbyte/connections/incremental-deduped-history) sync mode.
80
77
81
78
## Supported Objects
82
79
83
80
The Salesforce connector supports reading both Standard Objects and Custom Objects from Salesforce. Each object is read as a separate stream. 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).
84
81
85
-
86
82
Airbyte fetches and handles all the possible and available streams dynamically based on:
87
83
88
-
* If the authenticated Salesforce user has the Role and Permissions to read and fetch objects
84
+
* If the authenticated Salesforce user has the Role and Permissions to read and fetch objects
89
85
90
86
* If the stream has the queryable property set to true. Airbyte can fetch only queryable streams via the API. If you don’t see your object available via Airbyte, check if it is API-accessible to the Salesforce user you authenticated with in Step 2.
91
87
@@ -117,37 +113,37 @@ Now that you have set up the Salesforce source connector, check out the followin
117
113
*[Replicate Salesforce data to BigQuery](https://airbyte.com/tutorials/replicate-salesforce-data-to-bigquery)
118
114
*[Replicate Salesforce and Zendesk data to Keen for unified analytics](https://airbyte.com/tutorials/salesforce-zendesk-analytics)
| 0.1.21 | 2022-01-28 |[9499](https://github.com/airbytehq/airbyte/pull/9499)| If a sync reaches daily rate limit it ends the sync early with success status. Read more in `Performance considerations` section |
| 0.1.18 | 2022-01-20 |[9478](https://github.com/airbytehq/airbyte/pull/9478)| Add available stream filtering by `queryable` flag |
136
-
| 0.1.17 | 2022-01-19 |[9302](https://github.com/airbytehq/airbyte/pull/9302)| Deprecate API Type parameter |
137
-
| 0.1.16 | 2022-01-18 |[9151](https://github.com/airbytehq/airbyte/pull/9151)| Fix pagination in REST API streams |
138
-
| 0.1.15 | 2022-01-11 |[9409](https://github.com/airbytehq/airbyte/pull/9409)| Correcting the presence of an extra `else` handler in the error handling |
139
-
| 0.1.14 | 2022-01-11 |[9386](https://github.com/airbytehq/airbyte/pull/9386)| Handling 400 error, while `sobject` doesn't support `query` or `queryAll` requests |
140
-
| 0.1.13 | 2022-01-11 |[8797](https://github.com/airbytehq/airbyte/pull/8797)| Switched from authSpecification to advanced_auth in specefication |
141
-
| 0.1.12 | 2021-12-23 |[8871](https://github.com/airbytehq/airbyte/pull/8871)| Fix `examples` for new field in specification |
142
-
| 0.1.11 | 2021-12-23 |[8871](https://github.com/airbytehq/airbyte/pull/8871)| Add the ability to filter streams by user |
143
-
| 0.1.10 | 2021-12-23 |[9005](https://github.com/airbytehq/airbyte/pull/9005)| Handling 400 error when a stream is not queryable |
| 0.1.8 | 2021-11-30 |[8191](https://github.com/airbytehq/airbyte/pull/8191)| Make `start_date` optional and change its format to `YYYY-MM-DD`|
146
-
| 0.1.7 | 2021-11-24 |[8206](https://github.com/airbytehq/airbyte/pull/8206)| Handling 400 error when trying to create a job for sync using Bulk API. |
147
-
| 0.1.6 | 2021-11-16 |[8009](https://github.com/airbytehq/airbyte/pull/8009)| Fix retring of BULK jobs |
148
-
| 0.1.5 | 2021-11-15 |[7885](https://github.com/airbytehq/airbyte/pull/7885)| Add `Transform` for output records |
| 0.1.21 | 2022-01-28 |[9499](https://github.com/airbytehq/airbyte/pull/9499)| If a sync reaches daily rate limit it ends the sync early with success status. Read more in `Performance considerations` section |
| 0.1.18 | 2022-01-20 |[9478](https://github.com/airbytehq/airbyte/pull/9478)| Add available stream filtering by `queryable` flag |
132
+
| 0.1.17 | 2022-01-19 |[9302](https://github.com/airbytehq/airbyte/pull/9302)| Deprecate API Type parameter |
133
+
| 0.1.16 | 2022-01-18 |[9151](https://github.com/airbytehq/airbyte/pull/9151)| Fix pagination in REST API streams |
134
+
| 0.1.15 | 2022-01-11 |[9409](https://github.com/airbytehq/airbyte/pull/9409)| Correcting the presence of an extra `else` handler in the error handling |
135
+
| 0.1.14 | 2022-01-11 |[9386](https://github.com/airbytehq/airbyte/pull/9386)| Handling 400 error, while `sobject` doesn't support `query` or `queryAll` requests |
136
+
| 0.1.13 | 2022-01-11 |[8797](https://github.com/airbytehq/airbyte/pull/8797)| Switched from authSpecification to advanced_auth in specefication |
137
+
| 0.1.12 | 2021-12-23 |[8871](https://github.com/airbytehq/airbyte/pull/8871)| Fix `examples` for new field in specification |
138
+
| 0.1.11 | 2021-12-23 |[8871](https://github.com/airbytehq/airbyte/pull/8871)| Add the ability to filter streams by user |
139
+
| 0.1.10 | 2021-12-23 |[9005](https://github.com/airbytehq/airbyte/pull/9005)| Handling 400 error when a stream is not queryable |
| 0.1.8 | 2021-11-30 |[8191](https://github.com/airbytehq/airbyte/pull/8191)| Make `start_date` optional and change its format to `YYYY-MM-DD`|
142
+
| 0.1.7 | 2021-11-24 |[8206](https://github.com/airbytehq/airbyte/pull/8206)| Handling 400 error when trying to create a job for sync using Bulk API. |
143
+
| 0.1.6 | 2021-11-16 |[8009](https://github.com/airbytehq/airbyte/pull/8009)| Fix retring of BULK jobs |
144
+
| 0.1.5 | 2021-11-15 |[7885](https://github.com/airbytehq/airbyte/pull/7885)| Add `Transform` for output records |
0 commit comments