Establishing a Connection
Configure a Connection Profile
From the CData ribbon, click Get Data and select From HubSpot connection/s to launch the CData Query window. To setup a new connection, you will have to click the New HubSpot Connection button. Here you can set the connection settings, test the connection, and save the connection profile.
Authenticating to HubSpot
HubSpot supports OAuth authentication and PrivateAppToken-based authentication.
OAuth
HubSpot provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.
The following subsections describe how to authenticate to HubSpot from the available OAuth flows. For information about how to create a custom OAuth aplication, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in HubSpot, see Connection.
Desktop Applications
CData provides an embedded OAuth application that simplifies authentication at the desktop;.You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the HubSpot console. For further information, see Creating a Custom OAuth Application.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- OAuthClientId (custom applications only): The client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret (custom applications only): The client secret assigned when you registered your custom OAuth application.
- CallbackURL (custom applications only): The redirect URI defined when you registered your custom OAuth application.
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.
To generate a HubSpot Private App Token:
- In your HubSpot account, click the settings icon in the main navigation bar.
- In the left sidebar menu, navigate to Integrations > Private Apps.
- Click Create private app.
- On the Basic Info tab, configure the details of your application (name, logo, and description).
- 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.
- After you are done configuring your application, click create app in the top right.
- Review the information about your application's access token, click Continue creating, and then click Show token.
You can now set the retrieved token in the OAuthAccessToken property. (OAuthAccessToken is used for Private App Access Tokens and OAuth Access Tokens.)
Connection Properties
The Connection properties describe the various options that can be used to establish a connection.
Managing Connections
After successfully authenticating to HubSpot you will be able to customize the data you are importing. To learn more about this, see Managing Connections.
See Also
- Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
- Using the Excel Add-In: Find other ways to interact with HubSpot data, such as using the available CData Excel Functions.