Back to plugin list
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.4
Type
Source
Platforms
Date Published
Mar 12, 2024
Price
Free
Set up process
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 copy the App Token to the spec.
If not specified
HUBSPOT_APP_TOKEN
environment variable will be used instead.export HUBSPOT_APP_TOKEN=<your_app_token> # optional, if not using spec configuration
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.1.4"
destinations: ["postgresql"]
tables: ["*"]
spec:
# required, unless the HUBSPOT_APP_TOKEN environment variable is set
app_token: "${HUBSPOT_APP_TOKEN}"
# optional, default is 5.
# See https://developers.hubspot.com/docs/api/usage-details#rate-limits
# max_requests_per_second: 5
HubSpot Spec
This is the specs that can be used by the HubSpot source Plugin.
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 theHUBSPOT_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.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 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 entityproperties
([]string
) (optional) (default: empty)Additional properties to be retrieved from HubSpot when syncing the table entity