Hubspot Connector for Alteryx : Update deals via SQL

Integrate Alteryx and Hubspot
Integrate Alteryx and Hubspot

Learn how to update deals using the Hubspot Connector for Alteryx. This connector enables you to read and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Create data source using Hubspot ODBC Driver

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source
  3. Create a User data source (User DSN) based on the ZappySys API Driver driver:

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
    • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
  4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Hubspot" from the list of Popular Connectors. If "Hubspot" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    HubspotDSN
    Hubspot
    ODBC DSN Template Selection
  5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Hubspot authentication

    Private apps allow you to use HubSpot's APIs to access specific data from your HubSpot account. You can authorize what each private app can request or change in your account, which will generate an access token that's unique to your app. [API reference]

    Follow these instructions to create a Private app in HubSpot and configure HubSpot authentication in SSIS package or ODBC data source:

    1. First of all, go to HubSpot portal.
    2. Then click Data Management option on the left and then hit Integrations menu item: Go to integrations in HubSpot
    3. Move on by clicking Private Apps menu item and then click Create a private app button to create one: Create private app to get HubSpot data via REST API
    4. Then continue by following the instructions on HubSpot Docs.
    5. Once you create an app, go to SSIS package or ODBC data source and in Private App authentication set these parameters:
      • For AccessToken field use Access token value from the Private app configuration in HubSpot.
    6. Done! Now you are ready to use HubSpot Connector!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Private app (Static Access Token) [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    HubspotDSN
    Hubspot
    Private app (Static Access Token) [Http]
    https://api.hubapi.com
    Required Parameters
    AccessToken Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration
    Hubspot authentication

    In HubSpot, a public app is a type of integration that can be installed on customer accounts or listed on the App Marketplace. It requires authentication via OAuth. Once a user installs your app on their HubSpot account, you’ll be able to make API calls to that account using an OAuth access token. [API reference]

    Follow these instructions to create a Public app in HubSpot and configure HubSpot authentication in SSIS package or ODBC data source:

    1. First of all, if you don't have HubSpot Developer's account, register one.
    2. Go to HubSpot and select your Developer account.
    3. Click Apps on the left hand side and then click Create app button to create a Public app: Create public app to get HubSpot data via REST API
    4. Then continue by following the instructions in HubSpot Docs.
      NOTE: If you don't have a working Redirect URL, you can use https://zappysys.com/oauth (it's safe).

    5. Once you create an app, go to SSIS package or ODBC data source and in Public app authentication set these parameters (use values from your Public app configuration in HubSpot):
      • For ClientId field use Client ID value.
      • For ClientSecret field use Client secret value.
      • For Scope field use Scopes values, e.g.:
        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
        
        NOTE: You can use other scopes too, but they must match the scopes defined in your Public app.

      • For ReturnUrl field use one of Redirect URLs.
    6. When you are done with that, click Generate Token button to generate Access and Refresh Tokens.
    7. Done! Now you are ready to use HubSpot Connector!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Public app [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    HubspotDSN
    Hubspot
    Public app [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
    Client Secret
    ReturnUrl
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN OAuth Connection Configuration
    Hubspot authentication

    Deprecated authentication method. Use [Private app] instead. [API reference]

    Using HubSpot API key is deprecated method for authentication. Use Private app authentication instead. If you still need one, then follow these instructions to get HubSpot API key:

    • First of all, if you don't have HubSpot Developer's account, register one.
    • Go to HubSpot and select your Developer account.
    • Click Apps on the left hand side and then click Get HubSpot API key button to get one: Get HubSpot API key
    • When a popup appears, click Show Key button and then hit Copy button to copy API key: Use API key to read HubSpot data via REST API
    • Once copy the API key, go to SSIS package or ODBC data source and use it in API Key authentication configuration:
      • Paste it in ApiKey parameter field.
    • Done! Now you are ready to use HubSpot Connector!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Developer API key (Deprecated) [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    HubspotDSN
    Hubspot
    Developer API key (Deprecated) [Http]
    https://api.hubapi.com
    Required Parameters
    ApiKey Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

  6. Then go to Preview tab to start building a SQL query.

  7. Once you do that, proceed by opening Query Builder:

    ZappySys API Driver - Hubspot
    Read and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.
    HubspotDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. Then simply select the Deals table and Update operation.

  9. Continue by configuring the Required parameters. You can also set optional parameters too.

  10. Move on by hitting Preview Data button to preview the results.

  11. If you see the results you need, simply copy the generated query:

    Deals
    Update
    This Endpoint has no parameters.
    -- We are out of SQL query examples for this Endpoint, sorry!
    -- But will try to get some very very soon!
    Query Builder
  12. Click OK to use built SQL query and close the Query Builder.

  13. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Alteryx:

    ZappySys API Driver - Hubspot
    Read and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.
    HubspotDSN
    -- We are out of SQL query examples for this Endpoint, sorry!
    -- But will try to get some very very soon!
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Hubspot API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Hubspot servers).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Hubspot SQL query examples

Use these SQL queries in your Alteryx data source:

Update Deals

-- We are out of SQL query examples for this Endpoint, sorry!
-- But will try to get some very very soon!

update_deals endpoint belongs to Deals table(s), and can therefore be used via those table(s).

Create SQL view in ODBC data source

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table
  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"
    ZappySys Driver - Execute Custom Virtual Table Query

Update deals in Alteryx via SQL view

  1. Open Alteryx Designer.

  2. First, verify your DCM Settings to ensure you can access ODBC drivers. Go to Options > User Settings > Edit User Settings.

    If DCM Mode is set to DCM Only, change it to DCM Optional if you would like to access the legacy Generic ODBC Connection.

    Alteryx DCM User Settings for ODBC access
    After changing this setting, you may need to click Save and restart the connection window for the "Generic ODBC" icon to appear.
  3. Drag an Input Data tool onto your Alteryx canvas.

    Drag Input Data tool onto Alteryx canvas
  4. In the Configuration pane, click Set Up a Connection.

    Set Up a Connection in Alteryx Input Data configuration
  5. Note for DCM Users: If your environment has DCM (Data Connection Manager) enabled, the classic "Generic ODBC" icon may be hidden. To find it, select Data sources on the left and type "ODBC" in the search bar.

  6. Once the ODBC window opens, click Connect Asset and select your HubspotDSN DSN from the list.

    Connect Asset and select ODBC DSN in Alteryx
    Ensure you have configured a 64-bit System DSN in the Windows ODBC Data Source Administrator before this step.
  7. After selecting your DSN, configure your SQL Query in the Input Data tool configuration:

    Configure SQL Query in Alteryx Input Data tool
  8. To save your data, drag an Output Data tool and connect it to the Input Data tool.

  9. Configure the Output Data tool to write to a CSV file:

    Configure Output Data to CSV in Alteryx
  10. Press Run (Ctrl+R) to execute the workflow. Verify the results in the Results Window at the bottom.

    Run Alteryx workflow and view results

Advanced topics

Creating SQL stored procedures

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver. Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    
    ZappySys Driver - Create Custom Stored Procedure
  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';
    ZappySys Driver - Execute Custom Stored Procedure

Conclusion

And there you have it — a complete guide on how to update deals in Alteryx without writing complex code. All of this was powered by Hubspot ODBC Driver, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

More actions supported by Hubspot Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Hubspot operations directly in Alteryx, so you can skip the trial and error. Find your next step-by-step guide below:

More Hubspot integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications