1
0
mirror of synced 2025-12-30 12:04:43 -05:00
Files
airbyte/docs/integrations/sources/hubspot.inapp.md
Christo Grabowski cb1081e680 📝 Docs: update HubSpot source page (#28022)
* docs: hubspot source page cleanup

* rework setup steps

* add branching paths for cloud vs oss authentication

* merge engagement-screen-notes sections

* move step skipping note for Cloud users to top of setup

* update in-app setup steps to match docs

* remove stream scopes list from inapp guide

* added stream list back to inapp guide

* remove sentence implying start date is optional

* small touch-ups and fixes

* fix typo

* modify engagements note and add env-specific sections

* add recommended tags to authentication methods
2023-07-12 08:31:04 -07:00

2.9 KiB

Prerequisites

  • HubSpot Account
  • For Airbyte Open Source: Private App with Access Token

Authentication method

You can use OAuth or a Private App to authenticate your HubSpot account. For Airbyte Cloud users, we highly recommend you use OAuth rather than Private App authentication, as it significantly simplifies the setup process.

For more information on which authentication method to choose and the required setup steps, see our full Hubspot documentation.

Scopes Required (for Private App and Open Source OAuth)

Unless you are authenticating via OAuth on Airbyte Cloud, you must manually configure scopes to ensure Airbyte can sync all available data. To see a breakdown of the specific scopes each stream uses, see our full Hubspot documentation.

  • content
  • forms
  • tickets
  • automation
  • e-commerce
  • sales-email-read
  • crm.objects.companies.read
  • crm.schemas.companies.read
  • crm.objects.lists.read
  • crm.objects.contacts.read
  • crm.objects.deals.read
  • crm.schemas.deals.read
  • crm.objects.goals.read
  • crm.objects.owners.read
  • crm.objects.custom.read

Setup guide

  1. Log in to your Airbyte Cloud or Airbyte Open Source account.
  2. From the Airbyte UI, click Sources, then click on + New Source and select HubSpot from the list of available sources.
  3. Enter a Source name of your choosing.
  4. From the Authentication dropdown, select your chosen authentication method:

For Airbyte Cloud users:

  • To authenticate using OAuth, select OAuth and click Authenticate your HubSpot account to sign in with HubSpot and authorize your account.
  • To authenticate using a Private App, select Private App and enter the Access Token for your HubSpot account.

For Airbyte Open Source users:

  • To authenticate using OAuth, select OAuth and enter your Client ID, Client Secret, and Refresh Token.
  • To authenticate using a Private App, select Private App and enter the Access Token for your HubSpot account.
  1. For Start date, use the provided datepicker or enter the date programmatically in the following format: yyyy-mm-ddThh:mm:ssZ. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data.
  2. Click Set up source and wait for the tests to complete.

Supported Objects

Airbyte supports syncing standard and custom CRM objects. Custom CRM objects will appear as streams available for sync, alongside the standard objects.

For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for Hubspot.