Help Manual

HubSpot SSIS Components

Learn how to use HubSpot components found within SSIS Integration Toolkit

Using the HubSpot Source Component

The HubSpot Source Component is an SSIS data flow pipeline component that can be used to read/retrieve data from HubSpot.

The component includes the following two pages to configure how you want to read data from HubSpot:

  • General
  • Columns

General Page

The General page of the HubSpot Source Component allows you to specify the general settings of the component.

HubSpot Source Editor

Connection Manager

The HubSpot Source Component requires a HubSpot connection in order to connect with HubSpot. The Connection Manager drop-down will show a list of all HubSpot connection managers that are available to the current SSIS package.

Source Object

The Source Object drop-down lists all of the currently supported objects which you can read from.

Batch Size

The Batch Size lets you specify how many records to retrieve per service call to HubSpot. Some objects, however, retrieve all records in one service call. The Batch Size field will become disabled for objects such as this.

Note: When the Batch Size property is disabled in the HubSpot Source Component, it means that for the particular Source Object you have selected, it will make a single request to retrieve all of the records.

Output Timezone

The Output Timezone option lets you specify how all datetime fields should be retrieved. The default value is UTC. There is also the option to convert to Local Time. There is no performance difference between the two options, it simply makes integration easier.

Use Search API

The Use Search API option allows you to retrieve data from supported HubSpot CRM objects using the HubSpot Search API. When enabled, the component provides additional filtering capabilities that can be used to narrow the records returned based on object properties.

When enabled, you can use Condition Builder Mode to configure search conditions or Custom Query Mode to define a custom search query.

Note: Search API availability and supported filtering options may vary depending on the selected Source Object.

Recently Created Only

The Recently Created Only option can be used to get all records that have been created in the last 30 days, or the 10k most recently created records.

Note: This option is currently available for the Deal and Engagement objects. Support for the Contact and Company objects was deprecated as of v25.1.1.

Recently Modified Only

The Recently Modified Only option can be used to get all records that have been modified in the last 30 days, or the 10k most recently modified records.

Note: This option is currently available for the Deal object. Support for the Contact and Company objects was deprecated as of v25.1.1.

Associated Deals Only

The Associated Deals Only option can be used to retrieve deals associated with a specified HubSpot object. When enabled, use the available objectType and objectId Filter Parameters to identify the associated object.

Filter Parameters

You can specify filtering parameters so that the source component only returns those records that satisfy such filtering parameters. Filter fields vary from object to object along with the criteria. The different filter criteria include:

  • Equals: all records with a particular field that exactly matches the supplied value
  • Greater than: all records with a particular field greater than the supplied value (generally a timestamp)
  • Less than: all records with a particular field less than the supplied value (generally a timestamp)
  • Contains: all records with a particular field that contains the supplied value (Keyword object only)
  • In: all records where a particular field matches one of the supplied values
  • Smart Search (Deprecated as of v25.1.1): all records whose name (first or last) or email begins with the supplied value. (Contact object only)
    • Example: If the supplied value was "hub", the HubSpot Smart Search would return any contact whose first or last name began with "hub" (such as "HubSpot"). It would also return any contact whose email contains "hub" at either the beginning of the username or the domain portion of the email (such as "[email protected]" or "[email protected]").
Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic updates of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Columns Page

The Columns page of the HubSpot Source Component shows you all available attributes from the object that you specified on the General page.

HubSpot Source Editor

The HubSpot Source Component contains a special feature to toggle between the decimal and bigint data types. By default, all numeric fields are assigned a data type of decimal (excluding system fields that have a known type of bigint). If you wish to set specific fields to a data type of bigint (fields in which you are 100% sure are integers), simply click the toggle button. This saves the user from having to go into the advanced editor to do the same thing. This feature exists due to HubSpot API limitations.