Skip to content

Latest commit

 

History

History
316 lines (257 loc) · 42.8 KB

hubspot.md

File metadata and controls

316 lines (257 loc) · 42.8 KB
Raw

HubSpot

This page contains the setup guide and reference information for the HubSpot source connector.

Prerequisites

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

Setup guide

For Airbyte Cloud users, we highly recommend you use OAuth rather than Private App authentication, as it significantly simplifies the setup process.

For Airbyte Open Source users we recommend Private App authentication.

More information on HubSpot authentication methods can be found here.

Step 1: Set up the authentication method

Private App setup (Recommended for Airbyte Open Source)

If you are authenticating via a Private App, you will need to use your Access Token to set up the connector. Please refer to the official HubSpot documentation for a detailed guide.

OAuth setup for Airbyte Open Source (Not recommended)

If you are using Oauth to authenticate on Airbyte Open Source, please refer to Hubspot's detailed walkthrough. To set up the connector, you will need to acquire your:

  • Client ID
  • Client Secret
  • Refresh Token

Step 2: Configure the scopes for your streams

Next, you need to configure the appropriate scopes for the following streams. Please refer to Hubspot's page on scopes for instructions.

Stream Required Scope
campaigns content
companies crm.objects.companies.read, crm.schemas.companies.read
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
email_events content
email_subscriptions content
engagements crm.objects.companies.read, crm.objects.contacts.read, crm.objects.deals.read, tickets, e-commerce
engagements_emails sales-email-read
forms forms
form_submissions forms
goals crm.objects.goals.read
line_items e-commerce
owners crm.objects.owners.read
products e-commerce
property_history crm.objects.contacts.read
subscription_changes content
tickets tickets
workflows automation

Step 3: Set up the HubSpot source connector in Airbyte

  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:

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

For Airbyte Open Source users:

  • Recommended: To authenticate using a Private App, select Private App and enter the Access Token for your HubSpot account.
  • **Not Recommended:**To authenticate using OAuth, select OAuth and enter your Client ID, Client Secret, and Refresh Token.
  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.
  2. Click Set up source and wait for the tests to complete.

Supported sync modes

The HubSpot source connector supports the following sync modes:

  • Full Refresh
  • Incremental

:::note There are two types of incremental sync:

  1. Incremental (standard server-side, where API returns only the data updated or generated since the last sync)
  2. Client-Side Incremental (API returns all available data and connector filters out only new records) :::

Supported streams

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 set up 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.

Notes on the engagements stream

  1. Objects in the engagements stream can have one of the following types: note, email, task, meeting, call. Depending on the type of engagement, different properties are set for that object in the engagements_metadata table in the destination:
  • A call engagement has a corresponding engagements_metadata object with non-null values in the toNumber, fromNumber, status, externalId, durationMilliseconds, externalAccountId, recordingUrl, body, and disposition columns.
  • An email engagement has a corresponding engagements_metadata object with non-null values in the subject, html, and text columns. In addition, there will be records in four related tables, engagements_metadata_from, engagements_metadata_to, engagements_metadata_cc, engagements_metadata_bcc.
  • A meeting engagement has a corresponding engagements_metadata object with non-null values in the body, startTime, endTime, and title columns.
  • 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.
  1. The engagements stream uses two different APIs based on the length of time since the last sync and the number of records which Airbyte hasn't yet synced.
  • EngagementsRecent if the following two criteria are met:
    • The last sync was performed within the last 30 days
    • Fewer than 10,000 records are being synced
  • EngagementsAll if either of these criteria are not met.

Because of this, the engagements stream can be slow to sync if it hasn't synced within the last 30 days and/or is generating large volumes of new data. We therefore recommend scheduling frequent syncs.

Performance considerations

The connector is restricted by normal HubSpot rate limitations.

Some streams, such as workflows, need to be enabled before they can be read using a connector authenticated using an API Key. If reading a stream that is not enabled, a log message returned to the output and the sync operation only sync the other streams available.

Example of the output message when trying to read workflows stream with missing permissions for the API Key:

{
    "type": "LOG",
    "log": {
        "level": "WARN",
        "message": 'Stream `workflows` cannot be proceed. This API Key (EXAMPLE_API_KEY) does not have proper permissions! (requires any of [automation-access])'
    }
}

HubSpot's API will rate limit the amount of records you can sync daily, so make sure that you are on the appropriate plan if you are planning on syncing more than 250,000 records per day.

Tutorials

Now that you have set up the Hubspot source connector, check out the following Hubspot tutorial:

Build a single customer view with open-source tools

Changelog

Version Date Pull Request Subject
1.4.0 2023-08-11 29249 Add OwnersArchived stream
1.3.3 2023-08-10 29248 Specify threadId in engagements stream to type string
1.3.2 2023-08-10 29326 Add primary keys to streams ContactLists and PropertyHistory
1.3.1 2023-08-08 29211 Handle 400 and 403 errors without interruption of the sync
1.3.0 2023-08-01 28909 Add handling of source connection errors
1.2.0 2023-07-27 27091 Add new stream ContactsMergedAudit
1.1.2 2023-07-27 28558 Improve error messages during connector setup
1.1.1 2023-07-25 28705 Fix retry handler for token expired error
1.1.0 2023-07-18 28349 Add unexpected fields in schemas of streams email_events, email_subscriptions, engagements, campaigns
1.0.1 2023-06-23 27658 Use fully qualified name to retrieve custom objects
1.0.0 2023-06-08 27161 Fixed increment sync for engagements stream, 'Recent' API is used for recent syncs of last recent 30 days and less than 10k records, otherwise full sync if performed by 'All' API
0.9.0 2023-06-26 27726 License Update: Elv2
0.8.4 2023-05-17 25667 Fixed bug with wrong parsing of boolean encoded like "false" parsed as True
0.8.3 2023-05-31 26831 Remove authSpecification from connector specification in favour of advancedAuth
0.8.2 2023-05-16 26418 Added custom availability strategy which catches permission errors from parent streams
0.8.1 2023-05-29 26719 Handle issue when state value is literally "" (empty str)
0.8.0 2023-04-10 16032 Add new stream Custom Object
0.7.0 2023-04-10 24450 Add new stream Goals
0.6.2 2023-04-28 25667 Fixed bug with Invalid Date like 2000-00-00T00:00:00Z while settip up the connector
0.6.1 2023-04-10 21423 Update scope for DealPipelines stream to only crm.objects.contacts.read
0.6.0 2023-04-07 24980 Add new stream DealsArchived
0.5.2 2023-04-07 24915 Fix field key parsing (replace whitespace with uderscore)
0.5.1 2023-04-05 22982 Specified date formatting in specification
0.5.0 2023-03-30 24711 Add incremental sync support for campaigns, deal_pipelines, ticket_pipelines, forms, form_submissions, form_submissions, workflows, owners
0.4.0 2023-03-31 22910 Add email_subscriptions stream
0.3.4 2023-03-28 24641 Convert to int only numeric values
0.3.3 2023-03-27 24591 Fix pagination for marketing emails stream
0.3.2 2023-02-07 22479 Turn on default HttpAvailabilityStrategy
0.3.1 2023-01-27 22009 Set AvailabilityStrategy for streams explicitly to None
0.3.0 2022-10-27 18546 Sunsetting API Key authentication. Quotes stream is no longer available
0.2.2 2022-10-03 16914 Fix 403 forbidden error validation
0.2.1 2022-09-26 17120 Migrate to per-stream state.
0.2.0 2022-09-13 16632 Remove Feedback Submissions stream as the one using unstable (beta) API.
0.1.83 2022-09-01 16214 Update Tickets, fix missing properties and change how state is updated.
0.1.82 2022-08-18 15110 Check if it has a state on search streams before first sync
0.1.81 2022-08-05 15354 Fix Deals stream schema
0.1.80 2022-08-01 15156 Fix 401 error while retrieving associations using OAuth
0.1.79 2022-07-28 15144 Revert v0.1.78 due to permission issues
0.1.78 2022-07-28 15099 Fix to fetch associations when using incremental mode
0.1.77 2022-07-26 15035 Make PropertyHistory stream read historic data not limited to 30 days
0.1.76 2022-07-25 14999 Partially revert changes made in v0.1.75
0.1.75 2022-07-18 14744 Remove override of private CDK method
0.1.74 2022-07-25 14412 Add private app authentication
0.1.73 2022-07-13 14666 Decrease number of http requests made, disable Incremental mode for PropertyHistory stream
0.1.72 2022-06-24 14054 Extended error logging
0.1.71 2022-06-24 14102 Removed legacy AirbyteSentry dependency from the code
0.1.70 2022-06-16 13837 Fix the missing data in CRM streams issue
0.1.69 2022-06-10 13691 Fix the URI Too Long issue
0.1.68 2022-06-08 13596 Fix for the property_history which did not emit records
0.1.67 2022-06-07 13566 Report which scopes are missing to the user
0.1.66 2022-06-05 13475 Scope crm.objects.feedback_submissions.read added for feedback_submissions stream
0.1.65 2022-06-03 13455 Discover only returns streams for which required scopes were granted
0.1.64 2022-06-03 13218 Transform contact_lists data to comply with schema
0.1.63 2022-06-02 13320 Fix connector incremental state handling
0.1.62 2022-06-01 13383 Add line items to deals stream
0.1.61 2022-05-25 13381 Requests scopes as optional instead of required
0.1.60 2022-05-25 13159 Use RFC3339 datetime
0.1.59 2022-05-10 12711 Ensure oauth2.0 token has all needed scopes in "check" command
0.1.58 2022-05-04 12482 Update input configuration copy
0.1.57 2022-05-04 12198 Add deals associations for quotes
0.1.56 2022-05-02 12515 Extra logs for troubleshooting 403 errors
0.1.55 2022-04-28 12424 Correct schema for ticket_pipeline stream
0.1.54 2022-04-28 12335 Mock time slep in unit test s
0.1.53 2022-04-20 12230 Change spec json to yaml format
0.1.52 2022-03-25 11423 Add tickets associations to engagements streams
0.1.51 2022-03-24 11321 Fix updated at field non exists issue
0.1.50 2022-03-22 11266 Fix Engagements Stream Pagination
0.1.49 2022-03-17 11218 Anchor hyperlink in input configuration
0.1.48 2022-03-16 11105 Fix float numbers, upd docs
0.1.47 2022-03-15 11121 Add partition keys where appropriate
0.1.46 2022-03-14 10700 Handle 10k+ records reading in Hubspot streams
0.1.45 2022-03-04 10707 Remove stage history from deals stream to increase efficiency
0.1.44 2022-02-24 9027 Add associations companies to deals, ticket and contact stream
0.1.43 2022-02-24 10576 Cast timestamp to date/datetime
0.1.42 2022-02-22 10492 Add date-time format to datetime fields
0.1.41 2022-02-21 10177 Migrate to CDK
0.1.40 2022-02-10 10142 Add associations to ticket stream
0.1.39 2022-02-10 10055 Bug fix: reading not initialized stream
0.1.38 2022-02-03 9786 Add new streams for engagements(calls, emails, meetings, notes and tasks)
0.1.37 2022-01-27 9555 Getting form_submission for all forms
0.1.36 2022-01-22 7784 Add Property History Stream
0.1.35 2021-12-24 9081 Add Feedback Submissions stream and update Ticket Pipelines stream
0.1.34 2022-01-20 9641 Add more fields for email_events stream
0.1.33 2022-01-14 8887 More efficient support for incremental updates on Companies, Contact, Deals and Engagement streams
0.1.32 2022-01-13 8011 Add new stream form_submissions
0.1.31 2022-01-11 9385 Remove auto-generated properties from Engagements stream
0.1.30 2021-01-10 9129 Created Contacts list memberships streams
0.1.29 2021-12-17 8699 Add incremental sync support for companies, contact_lists, contacts, deals, line_items, products, quotes, tickets streams
0.1.28 2021-12-15 8429 Update fields and descriptions
0.1.27 2021-12-09 8658 Fixed config backward compatibility issue by allowing additional properties in the spec
0.1.26 2021-11-30 8329 Removed 'skip_dynamic_fields' config param
0.1.25 2021-11-23 8216 Add skip dynamic fields for testing only
0.1.24 2021-11-09 7683 Fix name issue 'Hubspot' -> 'HubSpot'
0.1.23 2021-11-08 7730 Fix OAuth flow schema
0.1.22 2021-11-03 7562 Migrate Hubspot source to CDK structure
0.1.21 2021-10-27 7405 Change of package import from urllib to urllib.parse
0.1.20 2021-10-26 7393 Hotfix for split_properties function, add the length of separator symbol ,(%2C in HTTP format) to the checking of the summary URL length
0.1.19 2021-10-26 6954 Fix issue with getting 414 HTTP error for streams
0.1.18 2021-10-18 5840 Add new marketing emails (with statistics) stream
0.1.17 2021-10-14 6995 Update discover method: disable quotes stream when using OAuth config
0.1.16 2021-09-27 6465 Implement OAuth support. Use CDK authenticator instead of connector specific authenticator
0.1.15 2021-09-23 6374 Use correct schema for owners stream
0.1.14 2021-09-08 5693 Include deal_to_contact association when pulling deal stream and include contact ID in contact stream
0.1.13 2021-09-08 5834 Fixed array fields without items property in schema
0.1.12 2021-09-02 5798 Treat empty string values as None for field with format to fix normalization errors
0.1.11 2021-08-26 5685 Remove all date-time format from schemas
0.1.10 2021-08-17 5463 Fix fail on reading stream using API Key without required permissions
0.1.9 2021-08-11 5334 Fix empty strings inside float datatype
0.1.8 2021-08-06 5250 Fix issue with printing exceptions
0.1.7 2021-07-27 4913 Update fields schema