The target-hubspot loader sends data into HubSpot after it was pulled from a source using an extractor
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-hubspot loader to your
project using
:meltano add -
Configure the target-hubspot
settings using
:meltano config
meltano add loader target-hubspotmeltano config target-hubspot set --interactiveNext 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
target-hubspot
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. 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 loader.
This plugin has the following capabilities:
- about
- schema-flattening
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
target-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:
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config target-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.
Access Token (access_token)
-
Environment variable:
TARGET_HUBSPOT_ACCESS_TOKEN
Your HubSpot private app API access token. See the docs for more details.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set access_token [value]Column Mapping (column_mapping)
-
Environment variable:
TARGET_HUBSPOT_COLUMN_MAPPING
An array including an object entry for each column in your import file stream.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set column_mapping [value]Date Format (date_format)
-
Environment variable:
TARGET_HUBSPOT_DATE_FORMAT -
Default Value:
YEAR_MONTH_DAY
The format for dates included in the import file stream.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set date_format [value]Import Operations (import_operations)
-
Environment variable:
TARGET_HUBSPOT_IMPORT_OPERATIONS -
Default Value:
UPDATE
Used to indicate whether the import should create and update, only create, or only update records for a certain object or activity.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set import_operations [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_HUBSPOT_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_HUBSPOT_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_HUBSPOT_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TARGET_HUBSPOT_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config target-hubspot set stream_maps [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-yellow){kind=icon}
-8-c0c0c4){kind=icon}
-2-c0c0c4){kind=icon}
