tap-hubspot

tap-hubspot is a Singer tap for Hubspot.

Built with the Meltano Singer SDK.

Capabilities

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening
• batch

Settings

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

Elastic License 2.0

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.

Installation

pipx install git+https://github.com/ryan-miranda-partners/tap-hubspot.git

Configure using environment variables

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.

Source Authentication and Authorization

A Hubspot access token is required to make API requests. (See Hubspot API docs for more info)

Permissions

The following scopes need to be added to your access token to access the following endpoints:

• Contacts: crm.schemas.contacts.read or crm.objects.contacts.read
• Users: settings.users.read
• Ticket Pipeline: media_bridge.read or crm.schemas.custom.read or timeline or tickets or e-commerce or crm.objects.goals.read
• Deal Pipeline: media_bridge.read or crm.schemas.custom.read or timeline or tickets or e-commerce or crm.objects.goals.read
• Properties: All of Tickets, crm.objects.deals.read, sales-email-read, crm.objects.contacts.read, crm.objects.companies.read, e-commerce, crm.objects.quotes.read
• Owners: crm.objects.owners.read
• Companies: crm.objects.companies.read
• Deals: crm.objects.deals.read
• Feedback Submissions: crm.objects.contacts.read
• Line Items: e-commerce
• Products: e-commerce
• Tickets: tickets
• Quotes: crm.objects.quotes.read or crm.schemas.quotes.read
• Goals: crm.objects.goals.read
• Emails: sales-email-read

For more info on the streams and permissions, check the Hubspot API Documentation.

Usage

You can easily run tap-hubspot by itself or in a pipeline using Meltano.

Streams Using v1 Endpoints

The following Streams use the v1 (legacy) endpoint in the Hubspot API:

1. TicketPipeline & DealPipeline: The v3 endpoint requires a pipeline ID parameter to make calls to the API. Because of this, you are limited to only pulling data for a single pipeline ID from v3, whereas the v1 API allows you to pull from all pipelines.
2. EmailSubscriptions: The v3 endpoint requires you to set a single email address to pull subscription data, whereas the v1 endpoint allows you to pull data from all emails.

Stream Inheritance

This project uses parent-child streams. Learn more about them here.

Executing the Tap Directly

tap-hubspot --version
tap-hubspot --help
tap-hubspot --config CONFIG --discover > ./catalog.json

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

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

Testing with Meltano

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

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.