The tap-hubspot Meltano extractor pulls data from the Hubspot API that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

Using the Command Line Interface

  1. Add the tap-hubspot extractor to your project using meltano add :

    meltano add extractor tap-hubspot
  2. Configure the settings below using meltano config .

Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
  2. Open the Extractors interface at http://localhost:5000/extractors.
  3. Click the “Add to project” button for “Hubspot”.
  4. Configure the settings below in the “Configuration” interface that opens automatically.

Next steps

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Settings

tap-hubspot requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Redirect URI (redirect_uri)

This is the URL that the user will be redirected to after they authorize your app for the requested scopes

See https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-hubspot set redirect_uri <redirect_uri>

export TAP_HUBSPOT_REDIRECT_URI=<redirect_uri>

Client ID (client_id)

This identifies the app used to connect to HubSpot.

See https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-hubspot set client_id <client_id>

export TAP_HUBSPOT_CLIENT_ID=<client_id>

Client Secret (client_secret)

The client secret used for authentication.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-hubspot set client_secret <client_secret>

export TAP_HUBSPOT_CLIENT_SECRET=<client_secret>

Refresh Token (refresh_token)

This is the refresh token provided by HubSpot.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-hubspot set refresh_token <refresh_token>

export TAP_HUBSPOT_REFRESH_TOKEN=<refresh_token>

Start Date (start_date)

This is the cutoff date for syncing historical data.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-hubspot set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_HUBSPOT_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help?

If you're having trouble getting the tap-hubspot extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page?

This page is generated from a YAML file that you can contribute changes to!