HubSpot Source Plugin

Latest: v1.5.0

The CloudQuery HubSpot plugin extracts HubSpot information and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more). It is based on the HubSpot API (opens in a new tab) and the github.com/clarkmcc/go-hubspot (opens in a new tab) library.

⚠️

The HubSpot REST API is rate limited (opens in a new tab). By default, CloudQuery makes up to 5 API requests per second - but you may need to increase/decrease this value depending on your HubSpot subscription. You can use the max_requests_per_second configuration option to change this value (see below).

Authentication

In Order for CloudQuery to sync resources from your HubSpot setup, you will need to authenticate with your HubSpot account. You will need to create a HubSpot Private App (opens in a new tab), and export the App Token in HUBSPOT_APP_TOKEN environment variable.

export HUBSPOT_APP_TOKEN=<your_app_token>

Configuration

The following example sets up the HubSpot plugin, and connects it to a postgresql destination:

kind: source
spec:
  name: "hubspot"
  path: cloudquery/hubspot
  version: "v1.5.0"
  destinations: ["postgresql"]
  tables: ["*"]
  spec:
    # optional, default is 5.
    # See https://developers.hubspot.com/docs/api/usage-details#rate-limits
    max_requests_per_second: 5
    table_options:
      hubspot_crm_companies:
        associations: []
        properties: []
      hubspot_crm_contacts:
        associations: []
        properties: []
      hubspot_crm_deals:
        associations: []
        properties: []
      hubspot_crm_line_items:
        associations: []
        properties: []
      hubspot_crm_products:
        associations: []
        properties: []
      hubspot_crm_quotes:
        associations: []
        properties: []
      hubspot_crm_tickets:
        associations: []
        properties: []

HubSpot Spec

This is the specs that can be used by the HubSpot source Plugin.

max_requests_per_second (int, optional. Default: 5)

Rate limit per second for requests done HubSpot API, this will depend on your HubSpot plan (https://developers.hubspot.com/docs/api/usage-details#rate-limits (opens in a new tab))
table_options (map[string]TableOptions spec, optional. Default: empty)

Table Options for HubSpot entities that will be synced.

Table Options

associations ([]string, optional. Default: empty)

Additional associations to be retrieved from HubSpot when syncing the table entity
properties ([]string, optional. Default: empty)

Additional properties to be retrieved from HubSpot when syncing the table entity

Tables Tables