tap-hubspot
tap-hubspot is a Singer tap for Hubspot.
Built with the Meltano Singer SDK.
catalog
state
discover
about
stream-maps
schema-flattening
batch
Setting | Required | Default | Description |
---|---|---|---|
access_token | False | None | Token to authenticate against the API service |
client_id | False | None | The OAuth app client ID. |
client_secret | False | None | The OAuth app client secret. |
refresh_token | False | None | The OAuth app refresh token. |
start_date | False | None | Earliest record date to sync |
end_date | False | None | Latest record date to sync |
stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
stream_map_config | False | None | User-defined config values to be used within map expressions. |
flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
flattening_max_depth | False | None | The max depth to flatten schemas. |
batch_config | False | None |
A full list of supported settings and capabilities is available by running: tap-hubspot --about
The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.
pipx install git+https://github.com/ryan-miranda-partners/tap-hubspot.git
This Singer tap will automatically import any environment variables within the working directory's
.env
if the --config=ENV
is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the .env
file.
A Hubspot access token is required to make API requests. (See Hubspot API docs for more info)
The following scopes need to be added to your access token to access the following endpoints:
crm.schemas.contacts.read
or crm.objects.contacts.read
settings.users.read
media_bridge.read
or crm.schemas.custom.read
or timeline
or tickets
or e-commerce
or crm.objects.goals.read
media_bridge.read
or crm.schemas.custom.read
or timeline
or tickets
or e-commerce
or crm.objects.goals.read
Tickets
, crm.objects.deals.read
, sales-email-read
, crm.objects.contacts.read
, crm.objects.companies.read
, e-commerce
, crm.objects.quotes.read
crm.objects.owners.read
crm.objects.companies.read
crm.objects.deals.read
crm.objects.contacts.read
e-commerce
e-commerce
tickets
crm.objects.quotes.read
or crm.schemas.quotes.read
crm.objects.goals.read
sales-email-read
For more info on the streams and permissions, check the Hubspot API Documentation.
You can easily run tap-hubspot
by itself or in a pipeline using Meltano.
The following Streams use the v1 (legacy) endpoint in the Hubspot API:
This project uses parent-child streams. Learn more about them here.
tap-hubspot --version
tap-hubspot --help
tap-hubspot --config CONFIG --discover > ./catalog.json
Follow these instructions to contribute to this project.
pipx install poetry
poetry install
Create tests within the tests
subfolder and
then run:
poetry run pytest
You can also test the tap-hubspot
CLI interface directly using poetry run
:
poetry run tap-hubspot --help
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Your project comes with a custom meltano.yml
project file already created. Open the meltano.yml
and follow any "TODO" items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-hubspot
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-hubspot --version
# OR run a test `elt` pipeline:
meltano elt tap-hubspot target-jsonl
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.