Skip to main content

Setup HubSpot source

Updated

Pulls deals, contacts, companies, engagements, pipelines and marketing data from HubSpot using a Private App access token.

Setup at a glance

  1. 01HubSpotAcquire credentials
  2. 02KleeneComplete Setup
  3. Connected
  • Connector type API
  • Auth method Private App access token

Before you start

  • Access to your HubSpot account so you can create a Private App
  • Enterprise-level HubSpot access if you need Marketing Events data

Connect HubSpot to Kleene

  1. Get your HubSpot credentials

    1. In your HubSpot account, click the settings icon in the main navigation bar.
    2. In the left sidebar menu, navigate to Integrations → Private Apps.
    3. Click Create private app.
    4. On the Basic Info tab, configure the details of your app: enter the app's name, hover over the placeholder logo and click the upload icon to upload a square image, and enter a description.
    5. Click the Scopes tab.
    6. Select the Read or Write checkbox for each scope you want the app to access — see the list below. You can search for a specific scope using the Find a scope search bar.
    7. When you're done configuring, click Create app in the top right.
    8. Once the Private App is set up you'll be able to see the API access token upon request.

    These are the scopes you will definitely need to make requests to the available Kleene extracts:

    • Business-Intelligence
    • Integration-sync
    • Content
    • Social
    • crm.objects.marketing_events.readrequires Enterprise level access
    • crm.objects.companies.read
    • crm.objects.deals.read
    • crm.objects.contacts.read
    • crm.objects.owners.read
    • sales-email-readto read engagement emails

  2. Add the source in Kleene

    1. In the Kleene app, go to Add a source.
    2. Scroll down or search for HubSpot.
    3. Click Connect to open the credentials panel.

  3. Enter your credentials and connect

    • Hubspot API Key

    The new source now appears on the Sources screen.

Before you extract — HubSpot limits and report notes

This guide covers source setup only. When you move on to creating extracts, these are the connector-specific things to know.

Connector capabilities

Backfill Yes — all-time
Incremental Yes — supported on Email Events and Marketing Campaigns
API reliability Reliable

Available reports

Reports cover Deals (including custom properties), Deal Associations, Engagements, Feedback Submissions, Owners, Pipelines, Properties, Calls, Line Items, Marketing Campaigns and more. See the full HubSpot report list on docs.kleene.ai for every report with its incremental and primary keys.

Extract notes

  • Custom Objects — the Custom Objects endpoint response contains a large amount of data, particularly in the properties and associations fields, so it is split across three reports: Custom Objects Metadata (the original response), Custom Objects Associations (unwinds the associations field) and Custom Objects Properties (unwinds the properties field).
  • There are two ways to retrieve custom object data. Option 1: the All Custom Objects Data report retrieves information from every custom object in the account in one extract — but this can be time-intensive given the potential data volume. Option 2 is generally preferred for faster results: run the Custom Objects Metadata report to get a list of fullyQualifiedNames, then enter one into the Custom Object Field in the Custom Objects Field Selection report to return data for that custom object.
  • The Workflows performance statistics report uses the DAY setting for the Time period.
  • Report names changed in connector version 0.0.13 — for example Deal Associations replaces Deal Associations (without engagements) and Deal Associations (engagements only), and several *DEPRECATED and *NEW APPROACH reports were removed or renamed.

Limits and gotchas

Marketing Campaigns report — long backfills and duplicates

If you have a large number of campaigns, this report may fail when using longer backfill periods. If you encounter errors or experience very long run times, try reducing the backfill range (for example, to 1 month). The report may also generate duplicates — deduplicate in a transform layer.

Older association reports

Older (*DEPRECATED) reports may have missed associations if the number exceeded 100.

Vendor reference: HubSpot API overview

Related to

Powered by Zendesk