Using the HubSpot Connection Manager

The HubSpot Connection Manager is an SSIS connection manager component that can be used to establish connections with HubSpot.

To add a HubSpot connection to your SSIS package, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "HubSpot" item to add the new HubSpot connection manager.

new connection

Add HubSpot Connection Manager

The HubSpot Connection Manager contains the following three pages which configures how you want to connect to HubSpot.

  • General
  • Advanced Settings
  • More Info

General

The General page on the HubSpot Connection Manager allows you to specify general settings for the connection.

HubSpot Connection Manager

Authentication
Generate New Token File

This button will open a dialog in order to generate a new Token File.

HubSpot Connection Manager

App Type
KingswaySoft

The Connection Manager will use the Client Id and Secret that is provided by KingswaySoft for your convenience when setting up the connection.

My Own App

Selecting this option will allow you to use your own Client ID and Secret to connect to HubSpot.

App Info
Client Id

The Client Id option allows you to specify the unique ID which identifies the application making the request.

Client Secret

The Client Secret option allows you to specify the client secret belonging to your app.

Redirect URI

The Redirect URI option allows you to specify the Redirect Url which was assigned to your app.

Scope

A space-separated set of scopes that your app will need access to.

Optional Scope

A space separated set of scopes that are optional for your app.

Sign In & Authorize
Use Default Browser to Sign In

When this option is checked the Sign In and Authorize button will open your default web browser in order to complete the OAuth authentication. When this option is unchecked, the Sign In and Authorize button will complete the entire OAuth authentication process inside of the toolkit.

Sign In & Authorize

This button allows you to login to the service endpoint and authorize your app to generate a token.

Signed In Account Details
Hub ID

Displays the HubSpot ID which the token file was created for.

Hub Domain

Displays the HubSpot Domain Name which the token file was created for.

User ID

Displays the User ID of the HubSpot account which was used to login with.

User

Displays the Username of the HubSpot account which was used to login with.

Token File
Password

This option allows you to assign a new password for the token file which will be created.

Save to Token File

This option allows specify the location of where the token file will be saved.

Path to Token File

This option allows you to specify the path to the token file on the file system. Since v7.2 we have added support for both file system path as well as Azure Blob Storage Shared Access Signature (SAS) URL. Please note that you would need write permission when specifying the URL.

Token File Password

This option allows you to specify the password of the selected token file.

Token File Details
Hub ID

Displays the HubSpot ID which the token file was created for.

Hub Domain

Displays the HubSpot Domain Name which the token file was created for.

User ID

Displays the User ID of the HubSpot account which was used to login with.

User

Displays the Username of the HubSpot account which was used to login with.

App Type

Displays the client application type which the token file was created with.

App Client ID

Displays the client application ID which the token file was created with.

Test Connection

After all the connection information has been provided, you may click the Test Connection button to test if the connection settings entered are valid.

Advanced Settings

The Advanced Settings page on the HubSpot Connection Manager allows you to specify some advanced and optional settings for the connection.

HubSpot Connection Manager

Proxy Server Settings
Proxy Mode (since v2.1)

Proxy Mode option allows to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system configured proxy)
  • Manual
Proxy Server

Using Proxy Server option, you can provide a proxy server to connect to HubSpot.

Port

The Port option allows you to specify port number of the proxy server for the connection.

Proxy authentication required

Select this option if your proxy server requires authentication. Doing so will activate the Username and Password fields below.

Username

The Username option allows you to specify the proxy user account.

Password

Using Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the HubSpot connection manager's ConnectionString property by default. This is done by design for security reasons. However you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Misc
Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.

API Throttling Rate (requests/sec)

The API Throttling Rate is based on the Throttle Limits in HubSpot. This rate is set to a 10 requests per second limit, by default, to respect the HubSpot API Throttle limit. If the API Throttling Rate exceeds 10 requests per second, the HubSpot server may decline your request.

Retry on Intermittent Errors
This is an option designed to help recover from possible intermittent outages or disruption of service. It prevents the integration process from stopping due to temporary issues. Enabling this option will allow service calls to be retried upon certain types of failure. A service call may be retried up to 3 times before an exception is fired. Retries occur after 0 seconds, 15 seconds, and 60 seconds.

Warning: We have designed our retry feature carefully such that the retry should only occur when it is deemed safe to do so; however, in some occasions such retry service calls could result in the creation of duplicate data.

More Info page

The More Info page shows some basic information about the toolkit. In this page, you can find the version information of the toolkit.

HubSpot Connection Manager