Back to plugin list
hubspot
Official

HubSpot

The CloudQuery HubSpot plugin extracts HubSpot information and loads it into any supported CloudQuery destination

Publisher

cloudquery

Repositorygithub.com
Latest version

v3.1.2

Type

Source

Platforms
Date Published

Jan 16, 2024

Price

Free

Set up process


brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync hubspot.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview

HubSpot Source Plugin

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 and the github.com/clarkmcc/go-hubspot library.

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, 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
  registry: cloudquery
  version: "v3.0.18"
  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.
  • concurrency (int, optional, default: 1000): A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
  • 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)
  • 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


Subscribe to product updates

Be the first to know about new features.