Excel Add-In for HubDB

Build 24.0.9060

Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From HubDB connection/s to launch the CData Query window. To setup a new connection, you will have to click the New HubDB Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to HubDB

There are two authentication methods available for connecting to HubDB data source: OAuth Authentication with a public HubSpot application and authentication with a Private application token.

OAuth

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

Desktop Applications

You must create a custom OAuth application to connect. See Creating a Custom OAuth App a procedure.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: Set this to the client secret assigned when you registered your application.
  • CallbackURL: Set this to the redirect URI defined when you registered your application.
When you connect, the add-in opens HubDB's OAuth endpoint in your default browser. Log in and grant permissions to the application. The add-in refreshes the access token automatically when it expires.

Private App

To connect using a Hubspot private application token, set the AuthScheme property to PrivateApp.

You can generate a private application token by following the steps below:

  1. In your HubDB account, click the settings icon (the gear) 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.
    • A minimum of hubdb and crm.objects.owners.read is required to access tables.
  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. Click Copy to copy the private application token.

To connect, set PrivateAppToken to the private application token you retrieved.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to HubDB you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

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