Tableau Connector for HubSpot

Build 23.0.8839

Configuring a Connection

After Installing the Connector you can connect and create a Data Source for data in HubSpot.

Setting Up a Data Source

Complete the following steps to connect to the data:

  1. Under Connect | To a Server, click More....
  2. Select the data source called HubSpot by CData.
  3. Enter the information required for the connection.
  4. Click Sign In.
  5. If necessary, select a Database and Schema to discover what tables and views are available.

Using the Connection Builder

The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.

There are two ways to access the connection builder:

  • On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for HubSpot folder.
  • You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.

In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.

Authenticating to HubSpot

There are two authentication methods available for connecting to HubSpot data source: PrivateAppToken-based and OAuth Authentication.

Some tables in the HubspotV3 schema may not work with the OAuth mechanism. This API limitation restricts their usage only to the PrivateAppToken-based authentication. Specifically, each table in the data-model section will mention the supported authentication mechanism.

OAuth

AuthScheme must be set to OAuth in all OAuth flows. The following OAuth flows assume you have done so.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your application.
  • CallbackURL (custom application only): Set this to the redirect URI defined when you registered your application.
When you connect, the connector opens HubSpot's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
  1. The connector obtains an access token from HubSpot and uses it to request data.
  2. Extracts the access token from the callback URL and authenticates requests.
  3. Saves OAuth values in the location specified in OAuthSettingsLocation. These values persist across connections.
The connector refreshes the access token automatically when it expires.

Private App Token

To connect using a Hubspot Private App Token, set the AuthScheme property to PrivateAppToken and OAuthAccessToken to the value of your application's access token, and you are ready to connect.

You can generate a HubSpot Private App Token by following the steps below:

  1. In your HubSpot account, click the settings icon in the main navigation bar.
  2. In the left sidebar menu, navigate to Integrations > Private Apps.
  3. Click Create private app.
  4. On the Basic Info tab, configure the details of your application (name, logo, and description).
  5. On the Scopes tab, select Read or Write for each scope you want your private application to be able to access. This determines the data the driver has access to retrieve. Refer to the OAuthRequiredScopes and OAuthOptionalScopes properties for recommended scopes to select.
  6. After you are done configuring your application, click create app in the top right.
  7. Review the info about your application's access token, click Continue creating, and then Show token.
  8. You can now set the retrieved token in the OAuthAccessToken property (OAuthAccessToken is used for Private App Access Tokens and OAuth Access Tokens).

You can set the AuthScheme to PrivateAppToken to enforce this Authentication scheme.

Next Step

See Using the Connector to create data visualizations.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839