The tap-hubspot extractor pulls data from Hubspot that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-hubspot extractor to your
project using
:meltano add -
Configure the tap-hubspot
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-hubspotmeltano config tap-hubspot set --interactivemeltano config tap-hubspot testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-hubspot
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- discover
- properties
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-hubspot settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-hubspot list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Client ID (client_id)
-
Environment variable:
TAP_HUBSPOT_CLIENT_ID
This identifies the app used to connect to HubSpot.
Configure this setting directly using the following Meltano command:
meltano config tap-hubspot set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_HUBSPOT_CLIENT_SECRET
The client secret used for authentication.
Configure this setting directly using the following Meltano command:
meltano config tap-hubspot set client_secret [value]Hubspot API Key (hapikey)
-
Environment variable:
TAP_HUBSPOT_HAPIKEY
This is the Hubspot API Key provided by HubSpot.
As an alternative to OAuth 2.0 authentication during development, you may specify this setting to authenticate with the HubSpot API. This should be used only for low-volume development work, as the HubSpot API Usage Guidelines specify that integrations should use OAuth for authentication.
Any OAuth authentication parameters will be ignored if this key is present!
Configure this setting directly using the following Meltano command:
meltano config tap-hubspot set hapikey [value]Redirect URI (redirect_uri)
-
Environment variable:
TAP_HUBSPOT_REDIRECT_URI
This is the URL that the user will be redirected to after they authorize your app for the requested scopes
Configure this setting directly using the following Meltano command:
meltano config tap-hubspot set redirect_uri [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_HUBSPOT_REFRESH_TOKEN
This is the refresh token provided by HubSpot.
Configure this setting directly using the following Meltano command:
meltano config tap-hubspot set refresh_token [value]Start Date (start_date)
-
Environment variable:
TAP_HUBSPOT_START_DATE
This is the cutoff date for syncing historical data.
Configure this setting directly using the following Meltano command:
meltano config tap-hubspot set start_date [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-11,600-c0c0c4){kind=icon}
-34-c0c0c4){kind=icon}
