HubSpot ( Real-Time )

This connector captures data from HubSpot into Flow collections.

Supported data resources

• Companies
• Contacts
• Deals
• Engagements
• Contact Lists
• Contact Lists Subscriptions
• Campaigns
• Subscription Changes
• Email Events
• Ticket Pipelines
• Deal Pipelines
• Engagements Calls
• Engagements Emails
• Engagements Meetings
• Engagements Notes
• Engagements Tasks
• Goal Targets
• Line Items
• Products
• Tickets
• Emails Subscriptions
• Marketing Forms
• Owners
• Properties

The following data resources are supported for pro accounts:

• Feedback Submissions
• Marketing Emails
• Workflows

Prerequisites

There are two ways to authenticate with HubSpot when capturing data: using OAuth2, or with a private app access token. Their prerequisites differ.

OAuth is recommended for simplicity in the Flow web app;

Using OAuth2 to authenticate with HubSpot in the Flow web app

• A HubSpot account

Configuring the connector specification manually

• A HubSpot account

• The access token for an appropriately configured private app on the Hubspot account.

Setup

To create a private app in HubSpot and generate its access token, do the following.

1. Ensure that your HubSpot user account has super admin privileges.

2. In HubSpot, create a new private app.

   1. Name the app "Estuary Flow," or choose another name that is memorable to you.

   2. Grant the new app Read access for all available scopes.

   3. Copy the access token for use in the connector configuration.

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the HubSpot Real-Time connector.

Endpoint

The following properties reflect the access token authentication method.

Property	Title	Description	Type	Required/Default
/credentials	Private Application	Authenticate with a private app access token	object	Required
/credentials/access_token	Access Token	HubSpot Access token.	string	Required
/credentials/credentials_title	Credentials	Name of the credentials set	string	Required, "Private App Credentials"
/start_date	Start Date	UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.	string	Required

Bindings

Property	Title	Description	Type	Required/Default
/name	Data resource	Name of the data resource.	string	Required
/interval	Interval	Interval between data syncs	string	Required

Sample

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-hubspot-native:dev
        config:
          credentials_title: Private App Credentials
          access_token: <secret>
    bindings:
      - resource:
          name: companies
          interval: PT420S
        target: ${PREFIX}/${COLLECTION_NAME}