Hubspot Docs: remove mention of API keys, improve various wordings (#…

…26533)
airbytehq · May 25, 2023 · cd9ea77 · cd9ea77
1 parent fd36557
commit cd9ea77
Showing 1 changed file with 15 additions and 12 deletions.
diff --git a/docs/integrations/sources/hubspot.md b/docs/integrations/sources/hubspot.md
@@ -4,7 +4,11 @@ This page guides you through setting up the HubSpot source connector.
 
 ## Prerequisite
 
-You can use OAuth, API key, or Private App to authenticate your HubSpot account. If you choose to use OAuth or Private App, you need to configure the appropriate [scopes](https://legacydocs.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes) for the following streams:
+You can use OAuth or a Private App to authenticate your HubSpot account. 
+
+In Airbyte Cloud, we highly recommend you use OAuth and not Private App authentication as it significantly simplifies the setup process. 
+
+If you are using either OAuth in Airbyte OSS or Private App authentication, you need to configure the appropriate [scopes](https://legacydocs.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes) for the following streams:
 
 | Stream                      | Required Scope                                                                                               |
 |:----------------------------|:-------------------------------------------------------------------------------------------------------------|
@@ -13,6 +17,7 @@ You can use OAuth, API key, or Private App to authenticate your HubSpot account.
 | `contact_lists`             | `crm.objects.lists.read`                                                                                     |
 | `contacts`                  | `crm.objects.contacts.read`                                                                                  |
 | `contacts_list_memberships` | `crm.objects.contacts.read`                                                                                  |
+| Custom CRM OBjects          | `crm.objects.custom.read`                                                                                    |
 | `deal_pipelines`            | `crm.objects.contacts.read`                                                                                  |
 | `deals`                     | `crm.objects.deals.read`, `crm.schemas.deals.read`                                                           |
 | `deals_archived`            | `crm.objects.deals.read`, `crm.schemas.deals.read`                                                           |
@@ -39,12 +44,9 @@ You can use OAuth, API key, or Private App to authenticate your HubSpot account.
 3. On the Set up the source page, select **HubSpot** from the Source type dropdown.
 4. Enter a name for your source.
 5. For **Start date**, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data.
-6. You can use OAuth or an API key to authenticate your HubSpot account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte Open Source.
+6. You can use OAuth or an Private Apps to authenticate your HubSpot account. We recommend using OAuth for Airbyte Cloud and an Private Apps for Airbyte Open Source.
     - To authenticate using OAuth for Airbyte Cloud, ensure you have [set the appropriate scopes for HubSpot](#prerequisite) and then click **Authenticate your HubSpot account** to sign in with HubSpot and authorize your account. 
-    - To authenticate using an API key for Airbyte Open Source, select **API key** from the Authentication dropdown and enter the [API key](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for your HubSpot account.    
-    :::note
-    Check the [performance considerations](#performance-considerations) before using an API key.
-    :::
+    - To authenticate using a Private App, select **Private App** from the Authentication dropdown and enter the Access Token for your HubSpot account which you can obtain by following the instructions provided by Hubspot [here](https://developers.hubspot.com/docs/api/private-apps).    
 7. Click **Set up source**.
 
 ## Supported sync modes
@@ -97,7 +99,13 @@ The HubSpot source connector supports the following streams:
 ### Custom CRM Objects
 Custom CRM Objects will appear as streams available for sync, alongside the standard objects listed above. 
 
-If you setup your connections before April 15th, 2023 (on Cloud) or before 0.8.0 (OSS) then you'll need to go to the Hubspot source settings page in the Airbyte UI and reauthenticate via Oauth to allow Airbyte the permissions to access custom objects. Then, go to the replication settings of your connection and click “refresh source schema” to pull in those new streams for syncing. 
+If you setup your connections before April 15th, 2023 (on Cloud) or before 0.8.0 (OSS) then you'll need to do some additional work to sync custom CRM objects.
+
+First you need to give the connector some additional permissions: 
+* **If you are using OAuth on Cloud** go to the Hubspot source settings page in the Airbyte UI and reauthenticate via Oauth to allow Airbyte the permissions to access custom objects. 
+* **If you are using OAuth on OSS or Private App auth (on OSS or Cloud)**: you'll need to go into the Hubspot UI where you created your private app or oauth application and add the `crm.objects.custom.read` scope to your app's scopes. See Hubspot's instructions here. 
+
+Then, go to the replication settings of your connection and click “refresh source schema” to pull in those new streams for syncing. 
 
 ### A note on the `engagements` stream
 
@@ -109,11 +117,6 @@ Objects in the `engagements` stream can have one of the following types: `note`,
 - A `note` engagement has a corresponding `engagements_metadata` object with non-null values in the `body` column.
 - A `task` engagement has a corresponding `engagements_metadata` object with non-null values in the `body`, `status`, and `forObjectType` columns.
 
-### New state strategy on Incremental streams
-
-Due to some data loss because an entity was updated during the synch, instead of updating the state by reading the latest record the state will be save with the initial synch time. With the proposed `state strategy`, it would capture all possible updated entities in incremental synch.
-
-
 ## Performance considerations
 
 The connector is restricted by normal HubSpot [rate limitations](https://legacydocs.hubspot.com/apps/api_guidelines).