Skip to main content Skip to complementary content

HubSpot 

HubSpot is an AI-powered customer platform with all the software, integrations, and resources you need to connect your marketing, sales, and customer service.

It replicates data using the HubSpot REST API.

See the Schema section for a list of objects available for replication.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Information noteMake sure that the account you use has read access to the tables you want to fetch.

To retrieve your access token:

  1. Log into HubSpot.
  2. Create a private app by following HubSpot's documentation.

    You must have a HubSpot super admin role to create a private app.

  3. Once your private app is created, navigate to Development.
  4. In the left sidebar menu, navigate to Legacy apps.
  5. Click the name of your app.
  6. Click the Auth tab > Show token to reveal your access token.
  7. Copy and paste your access token into a secured file.

Creating the connection

For more information, see Connecting to SaaS applications.

  1. Fill in the required connection properties.
  2. Provide a name for the connection in Connection name.

  3. Select Open connection metadata to define metadata for the connection when it has been created.

  4. Click Create.

Connection settings
SettingDescription
Data gateway

Select a Data Movement gateway if required by your use case.

Information note

This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None.

For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.

Start Date

Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.

Personal Access Token Personal access token.

Schema

Information note

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 2.

Custom HubSpot field replication

Custom object properties, or fields, are supported by HubSpot integration. It will query the properties list for each object and, if custom fields are available through HubSpot’s API, replicate them to your destination.

The data types of these fields will be the same as the data type in HubSpot. For example: A custom field containing date data will be a date field in your destination.

This is applicable to any object that supports custom fields in HubSpot.

HubSpot date/date-time values & UNIX timestamps

HubSpot uses UNIX-formatted timestamps in milliseconds to store date and datetime data. For more information, see Charts overview. It doesn’t perform any transformation during the replication process, meaning these values won’t be converted to timestamps before they’re loaded into your destination.

To account for this, consider creating a user-defined function to perform the conversion or building views on top of the raw data.

Depending on your destination, table and column names may not appear as they are outlined below.

campaigns

The campaigns table contains info about the campaigns in your HubSpot account.

Replication Method

Full Table

Primary Key

id

Useful links

HubSpot documentation

HubSpot API method

companies

The companies table contains info about the companies your HubSpot contacts belong to.

Replication Method

CDC

Primary Key

companyId

Useful links

HubSpot documentation

HubSpot API method

contact_lists

The contact_lists table contains info about the contacts lists in your HubSpot account. Contact lists are used to segment contacts into groups, and there are two types: dynamic (smart lists) and static.

Replication Method

CDC

Primary Key

listId

Replication Key

updatedAt

Useful links

HubSpot documentation

HubSpot API method

contacts

The contacts table contains info about individual contacts in HubSpot.

Contact properties

If properties have been set for the contact, additional fields beginning with properties__ will be included in the table. Note: Contacts will only have an entry for a property if that property has been set for the contact’s record.

HubSpot always types the value of properties fields as STRING despite the property type. Refer to HubSpot’s documentation for more info.

Replication Method

CDC

Primary Key

vid

Replication Key

versionTimestamp

Useful links

HubSpot documentation

HubSpot API method

contacts_by_company

The contacts_by_company table contains contact and company ID pairs, allowing you to join contacts to relevant company data.

To replicate data from this table, you must also select the parent companies table.

Replication Method

Full Table

Primary Keys

contact-id

company-id

Useful links

HubSpot documentation

custom_objects

Tables for custom CRM objects in your HubSpot account will have the same name as the object. For example, if you have a custom object named cars, the table will be named cars.

The fields listed below are standard fields; they are included in every custom object table. A field will be added for each property you select when configuring the table. The property names will be prefixed with property_. For example, if you have a property named model, it will appear as property_model.

Replication Method

CDC

Primary Key

id

Replication Key

updatedAt

Useful links

HubSpot documentation

deal_pipelines

The deal_pipelines table contains info about the deal stage and pipeline properties.

Replication Method

Full Table

Primary Key

pipelineId

Useful links

HubSpot documentation

HubSpot API method

deals

The deals table contains info about the deals in a HubSpot portal.

Replication Method

CDC

Primary Key

dealId

Useful links

HubSpot documentation

HubSpot API method

email_events

The email_events table contains info about email events and how recipients interact with content.

Email events and HubSpot permissions

Replicating this table requires Super Admin permissions in HubSpot. The Super Admin role is different than the Admin role, which you can read more about in HubSpot’s documentation.

If this table is selected and you don’t have Super Admin permissions in HubSpot, an error similar to the following will surface in the integration’s Extraction Logs:

tap - ERROR b'{"status":"error","message":"This oauth-token (**********) does not have proper permissions! (requires any of [email-access])", [...]

Replication Method

CDC

Primary Key

id

Useful links

HubSpot documentation

HubSpot API method

engagements

The engagements table contains info about all the engagements in a HubSpot portal.

Replication Method

CDC

Primary Key

engagement_id

Replication Key

lastUpdated

Useful links

HubSpot documentation

HubSpot API method

forms

The forms table contains info about your HubSpot website forms.

Replication Method

CDC

Primary Key

guid

Replication Key

updatedAt

Useful links

HubSpot documentation

HubSpot API method

owners

The owners table contains info about the owners that exist in your HubSpot portal. Owners are created and updated in HubSpot when new users are added or when owners are synced from Salesforce to HubSpot.

Replication Method

CDC

Primary Key

ownerId

Replication Key

updatedAt

Useful links

HubSpot documentation

HubSpot API method

subscription_changes

The subscription_changes table contains info about changes made subscriptions.

Replication Method

CDC

Primary Keys

recipient

portalId

timestamp

Useful links

HubSpot documentation

HubSpot API method

tickets

In HubSpot, tickets represents customer requests for help

Replication Method

CDC

Primary Key

id

Replication Key

updatedAt

Useful links

HubSpot API method

workflows

The workflows table contains info about the workflows in your HubSpot portal.

Note: The workflows stream only supports contact-based workflows.

Replication Method

CDC

Primary Key

id

Replication Key

updatedAt

Useful links

HubSpot documentation

HubSpot API method

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!