HubSpot Source Plugin

Authentication #

export HUBSPOT_APP_TOKEN=<your_app_token> # optional, if not using spec configuration

Configuration #

kind: source
spec:
  name: "hubspot"
  path: cloudquery/hubspot
  registry: cloudquery
  version: "v4.9.3"
  destinations: ["postgresql"]
  backend_options:
    table_name: "cq_state_hubspot"
    connection: "@@plugins.postgresql.connection"
  tables:
    - "hubspot_crm_companies"
    - "hubspot_crm_contacts"
    - "hubspot_crm_deals"
    - "hubspot_crm_line_items"
    - "hubspot_crm_owners"
    - "hubspot_crm_pipelines"
    - "hubspot_crm_products"
    - "hubspot_crm_quotes"
    - "hubspot_crm_tickets"
  # Learn more about the configuration options at https://cql.ink/hubspot_source
  spec:
    app_token: "${HUBSPOT_APP_TOKEN}" # required, unless the HUBSPOT_APP_TOKEN environment variable is set
#    max_requests_per_second: 5 # optional, see https://developers.hubspot.com/docs/api/usage-details#rate-limits

HubSpot Spec #

• app_token (string) (optional) (default: HUBSPOT_APP_TOKEN environment variable value) The HubSpot App Token to use for authentication. This can also be set with the HUBSPOT_APP_TOKEN environment variable.
• concurrency (integer) (optional) (default: 1000)

  A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
• scheduler (string) (optional) (default: dfs) The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.

  For more information about this, see performance tuning.
• max_requests_per_second (integer) (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