Hubspot Connector
Documentation
Version: 5
Documentation

How to read data from Hubspot in SSIS (Export data)


In this section we will learn how to configure and use Hubspot Connector in API Source to extract data from Hubspot.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Hubspot Connector from Popular Connector List or press Search Online radio button to download Hubspot Connector. Once downloaded simply use it in the configuration:

    Hubspot
    Hubspot Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Authenticate using static AccessToken (Private App) to access specific account. Follow 3 simple steps. 1) Create an App, 2) select permissions and 3) get Token and use on this UI. For more information on how to obtain AccessToken visit https://developers.hubspot.com/docs/api/private-apps [API Help..]

    Steps to get Hubspot Credentials

    Just follow this link on how to get an PrivateApp Access Token. Once you obtain it, paste it into AccessToken parameter: https://developers.hubspot.com/docs/api/private-apps

    Hubspot
    Private App (Static Access Token) [Http]
    https://api.hubapi.com
    Required Parameters
    AccessToken Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

    OAuth App must be created in HubSpot website. These settings typically found here https://developers.hubspot.com/docs/api/working-with-oauth. [API Help..]

    Steps to get Hubspot Credentials

    Just follow this link on how to create an API app: https://developers.hubspot.com/docs/api/creating-an-app On the App Scopes section make sure to select following scopes in order to access all features of this driver. You can choose more or less but keep in mind to select same or less number of scopes on Driver UI (Scopes Property) else it will not authorize the request. If you need File Upload feature then choose files scope.

    Your selected scopes when registering your app must match the scopes you enter here on the connector screen. You cannot request less or more scopes for now (it may change in future). If they don't match, the connector will not be able to work with your HubSpot account!
    		
    accounting
    tickets
    files
    ------------------
    crm.lists.read
    crm.lists.write
    ------------------
    crm.objects.contacts.read
    crm.objects.contacts.write
    crm.schemas.contacts.read
    ------------------
    crm.objects.custom.read
    crm.objects.custom.write
    crm.schemas.custom.read
    ------------------
    crm.objects.companies.read
    crm.objects.companies.write
    crm.schemas.companies.read
    ------------------
    crm.objects.deals.read
    crm.objects.deals.write
    crm.schemas.deals.read
    ------------------
    crm.objects.quotes.read
    crm.objects.quotes.write
    crm.schemas.quotes.read
    ------------------
    crm.objects.line_items.read
    crm.objects.line_items.write
    crm.schemas.line_items.read
    
    you can add more... but must select same number of scopes in the connection screen too (Scopes Parameter)
    

    Hubspot
    User Credentials (3-Legged) [OAuth]
    https://api.hubapi.com
    Required Parameters
    UseCustomApp Fill in the parameter...
    Scope (Must Match with App Scopes) Fill in the parameter...
    Optional Parameters
    Client ID Fill in the parameter...
    Client Secret Fill in the parameter...
    ReturnUrl Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

    Authenticate using Static API Key instead of userid / password. It can be found at https://app.hubspot.com/api-key/<YOUR_ACCOUNT_ID>>/call-log [API Help..]

    Steps to get Hubspot Credentials

    Just follow this link on how to get an API key. Once you obtain it, paste it into ApiKey parameter: https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key

    Hubspot
    API Key in URL (Deprecated) [Http]
    https://api.hubapi.com
    Required Parameters
    ApiKey Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

  9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Hubspot
    Hubpost Connector can be used to integrate Hubspot and your data source, e.g. Microsoft SQL Server, Oracle, Excel, Power BI, etc. Get, write, delete Hubspot data in a few clicks!
    API Source - Select Endpoint

  10. That's it! We are done! Just in a few clicks we configured the call to Hubspot using Hubspot Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Hubspot and load into target