HubSpot

HubSpot is a customer relationship management software that helps businesses attract visitors, connect with customers, and close deals.

Bruin supports HubSpot as a source for Ingestr assets, and you can use it to ingest data from HubSpot into your data warehouse.

In order to set up HubSpot connection, you need to add a configuration item in the .bruin.yml file and in asset file. You will need an api_key, which can be either a private app access token or a HubSpot service key — both are sent to HubSpot as a bearer token, so either works.

• For a service key, go to Settings → Integrations → Service Keys in your HubSpot account, create a key, grant it the required scopes, and copy the generated key. HubSpot has moved private apps to "legacy apps" and now recommends service keys for system-to-system data integrations.
• For a private app access token, go to Settings → Integrations → Private Apps, create a private app, grant it the required scopes, and copy the generated access token.

Note: HubSpot service keys are currently in public beta. The feature may change before general availability, so keep that in mind before relying on it for production workloads.

Follow the steps below to correctly set up HubSpot as a data source and run ingestion.

Configuration

Step 1: Add a connection to .bruin.yml file

To connect to HubSpot, you need to add a configuration item to the connections section of the .bruin.yml file. This configuration must comply with the following schema:

    connections:
      hubspot:
        - name: "my-hubspot"
          api_key: "pat-123"

• name: The name of the connection
• api_key: The credential used for authentication with the HubSpot API. Accepts either a private app access token or a HubSpot service key.

Step 2: Create an asset file for data ingestion

To ingest data from HubSpot, you need to create an asset configuration file. This file defines the data flow from the source to the destination. Create a YAML file (e.g., hubspot_ingestion.yml) inside the assets folder and add the following content:

name: public.hubspot
type: ingestr
connection: postgres

parameters:
  source_connection: my-hubspot
  source_table: 'companies'

  destination: postgres

• name: The name of the asset.
• type: Specifies the type of the asset. Set this to ingestr to use the ingestr data pipeline.
• connection: This is the destination connection, which defines where the data should be stored. For example: postgres indicates that the ingested data will be stored in a Postgres database.
• source_connection: The name of the hubspot connection defined in .bruin.yml.
• source_table: The name of the data table in hubspot that you want to ingest. For example, companies is a data table in hubspot that you may want to ingest.

Available Source Tables

Table	PK	Inc Key	Inc Strategy	Details
companies	hs_object_id	hs_lastmodifieddate	merge	Retrieves information about organizations.
contacts	hs_object_id	lastmodifieddate	merge	Retrieves information about visitors, potential customers, and leads.
deals	hs_object_id	hs_lastmodifieddate	merge	Retrieves deal records and tracks deal progress.
tickets	hs_object_id	hs_lastmodifieddate	merge	Handles requests for help from customers or users.
products	hs_object_id	hs_lastmodifieddate	merge	Retrieves pricing information of products.
quotes	hs_object_id	hs_lastmodifieddate	merge	Retrieves price proposals that salespeople can create and send to their contacts.
calls	hs_object_id	hs_lastmodifieddate	merge	Retrieves call engagement records.
emails	hs_object_id	hs_lastmodifieddate	merge	Retrieves email engagement records.
feedback_submissions	hs_object_id	hs_lastmodifieddate	merge	Retrieves customer feedback survey responses.
line_items	hs_object_id	hs_lastmodifieddate	merge	Retrieves individual products or services associated with deals.
meetings	hs_object_id	hs_lastmodifieddate	merge	Retrieves meeting engagement records.
notes	hs_object_id	hs_lastmodifieddate	merge	Retrieves note engagement records.
tasks	hs_object_id	hs_lastmodifieddate	merge	Retrieves task engagement records.
carts	hs_object_id	hs_lastmodifieddate	merge	Retrieves shopping cart records.
discounts	hs_object_id	hs_lastmodifieddate	merge	Retrieves discount records.
fees	hs_object_id	hs_lastmodifieddate	merge	Retrieves fee records.
invoices	hs_object_id	hs_lastmodifieddate	merge	Retrieves invoice records.
commerce_payments	hs_object_id	hs_lastmodifieddate	merge	Retrieves commerce payment records.
taxes	hs_object_id	hs_lastmodifieddate	merge	Retrieves tax records.
owners	id	–	merge	Retrieves HubSpot users who can be assigned to CRM records.
schemas	id	–	merge	Returns all object schemas that have been defined for your account.
pipelines	object_type, pipeline_id	–	replace	Pipeline definitions across all pipelined object types. One row per pipeline.
pipeline_stages	object_type, pipeline_id, stage_id	–	replace	Stage definitions for each pipeline. One row per stage.

Property History Tables

For every CRM object table listed above, a corresponding property history table is available. These tables return one row per property change, enabling you to track how properties changed over time.

Use the format property_history:<table> as the source_table value. An optional comma-separated list of property names can be appended (property_history:<table>:<prop1>,<prop2>,...) to restrict the history to just those properties.

Table	PK	Inc Key	Inc Strategy	Details
property_history:contacts	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for contacts.
property_history:companies	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for companies.
property_history:deals	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for deals.
property_history:tickets	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for tickets.
property_history:products	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for products.
property_history:quotes	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for quotes.
property_history:calls	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for calls.
property_history:emails	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for emails.
property_history:feedback_submissions	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for feedback submissions.
property_history:line_items	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for line items.
property_history:meetings	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for meetings.
property_history:notes	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for notes.
property_history:tasks	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for tasks.
property_history:carts	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for carts.
property_history:discounts	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for discounts.
property_history:fees	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for fees.
property_history:invoices	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for invoices.
property_history:commerce_payments	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for commerce payments.
property_history:taxes	hs_object_id, property_name, timestamp	timestamp	merge	Property change history for taxes.

Note: The owners and schemas tables do not have history variants. Custom objects also support history via property_history:custom:<objectType> (e.g., property_history:custom:myObject).

Overriding associations

Each built-in table fetches a default set of associations. You can override that list by appending :<assoc1>,<assoc2> to the table name. The suffix replaces the default list, so you can narrow it down to just what you need, or include custom object names. Use <table>: (colon with empty list) to skip associations entirely.

parameters:
  source_connection: my-hubspot
  source_table: 'contacts:companies,deals'   # only fetch companies and deals
  destination: postgres

parameters:
  source_connection: my-hubspot
  source_table: 'contacts:'                  # fetch contacts with no associations
  destination: postgres

Custom Objects

HubSpot allows you to create custom objects to store unique business data that's not covered by the standard objects. ingestr supports ingesting data from custom objects using the following format:

custom:<custom_object_name>

or with associations to other objects:

custom:<custom_object_name>:<associations>

Parameters

• custom_object_name: The name of your custom object in HubSpot (can be either singular or plural form)
• associations (optional): Comma-separated list of object types to include as associations (e.g., companies,deals,tickets,contacts)

Examples

Ingesting a custom object called "licenses":

parameters:
  source_connection: my-hubspot
  source_table: 'custom:licenses'
  destination: postgres

Ingesting a custom object with associations to companies, deals, and contacts:

parameters:
  source_connection: my-hubspot
  source_table: 'custom:licenses:companies,deals,contacts'
  destination: postgres

When you include associations, the response will contain information about the related objects, allowing you to track relationships between your custom objects and standard HubSpot objects.

Step 3: Run asset to ingest data

bruin run assets/hubspot_ingestion.yml

As a result of this command, Bruin will ingest data from the given HubSpot table into your Postgres database.