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

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/MeltanoLabs/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)

Streams

Permissions

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

• Contacts: crm.objects.contacts.read
• Companies: crm.objects.companies.read
• Deals: crm.objects.deals.read
• Associations: the read scope for each object type configured in associations (e.g. syncing ['contact', 'company'] needs crm.objects.contacts.read and crm.objects.companies.read)
• Leads: crm.objects.leads.read
• Owners: crm.objects.owners.read
• Users: settings.users.read
• Teams: settings.users.teams.read
• Feedback Submissions: crm.objects.feedback_submissions.read
• Calls: crm.objects.calls.read
• Communications: crm.objects.communications.read
• Emails: sales-email-read
• Meetings: crm.objects.meetings.read
• Notes: crm.objects.notes.read
• Postal Mail: crm.objects.postal_mail.read
• Tasks: crm.objects.tasks.read
• Line Items: e-commerce
• Products: e-commerce
• Tickets: tickets
• Ticket Pipelines: tickets
• Deal Pipelines: crm.objects.deals.read
• Quotes: crm.objects.quotes.read
• Goal Targets: crm.objects.goals.read
• Email Subscriptions: content
• Properties: same scopes as the corresponding object type
• Custom Objects: crm.objects.custom.read and crm.schemas.custom.read (HubSpot Enterprise only)

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

Associations

No association streams are created by default. To sync associations between two CRM object types, add an associations config setting mapping each from_object_type to a list of to_object_types, using HubSpot's object type names (e.g. contact, company, deal, ticket):

{
  "associations": {
    "contact": ["company", "deal"]
  }
}

Each from/to pair creates one full-table stream named <from_object_type>_<to_object_type>_associations (e.g. contact_company_associations), fetched via HubSpot's CRM v4 associations batch/read endpoint. Each record has from_id, to_id, association_type_id, association_type_category, and association_type_label.

Associations aren't reflected in an object's hs_lastmodifieddate, so these streams always do a full resync — there's no way to fetch only associations that changed since the last run.

Object type names must match HubSpot's CRM object type identifiers, not this tap's stream names. Common ones, including every object type this tap already has a stream for:

Any other standard or custom HubSpot object type name is also valid (e.g. order, invoice, or a custom object's fullyQualifiedName), as long as your access token has read access to both object types in the pair.

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

curl -LsSf https://astral.sh/uv/install.sh | sh  # https://docs.astral.sh/uv/getting-started/installation/
uv sync

Create and Run Tests

Create tests within the tests subfolder and then run:

uv run pytest

You can also test the tap-hubspot CLI interface directly using uv run:

uv 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
uv tool 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 EL pipeline:
meltano run 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.