How to integrate Hubspot with UiPath
Learn how to quickly and efficiently connect Hubspot with UiPath for smooth data access.
Read and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required. You can do it all using the high-performance Hubspot ODBC Driver for UiPath (often referred to as the Hubspot Connector). We'll walk you through the entire setup.
Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.
Create data source using Hubspot ODBC Driver
Step-by-step instructions
To get data from Hubspot using UiPath, we first need to create an ODBC data source. We will later read this data in UiPath. Perform these steps:
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ZappySys API Driver driver:
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
-
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:
HubspotDSNHubspot
-
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:
- First of all, go to HubSpot portal.
-
Then click Data Management option on the left
and then hit Integrations menu item:
-
Move on by clicking Private Apps menu item
and then click Create a private app button to create one:
- Then continue by following the instructions on HubSpot Docs.
-
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.
- Done! Now you are ready to use HubSpot Connector!
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Private app (Static Access Token) [Http] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
HubspotDSNHubspotPrivate app (Static Access Token) [Http]https://api.hubapi.comRequired Parameters AccessToken Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True
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:
- 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 Create app button to create a Public app:
-
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).- 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.
- When you are done with that, click Generate Token button to generate Access and Refresh Tokens.
- Done! Now you are ready to use HubSpot Connector!
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Public app [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Press Generate Token button to generate the tokens.
- Finally, hit OK button:
HubspotDSNHubspotPublic app [OAuth]https://api.hubapi.comRequired 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
- 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):
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:
-
When a popup appears, click Show Key button and then hit Copy button to copy API key:
-
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:
-
Set Authentication Type to
Developer API key (Deprecated) [Http] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
HubspotDSNHubspotDeveloper API key (Deprecated) [Http]https://api.hubapi.comRequired Parameters ApiKey Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - HubspotRead and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.HubspotDSN
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in UiPath to retrieve data from Hubspot. Hit OK button to use this query in the next step.
SELECT * FROM Companies -- WHERE Id=123
Some parameters configured in this window will be passed to the Hubspot API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster .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 UiPath:
ZappySys API Driver - HubspotRead and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.HubspotDSNSELECT * FROM Companies -- WHERE Id=123
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHEREclause,LIMITkeyword will be performed on the client side, meaning that thewhole 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).Click OK to finish creating the data source.
Video Tutorial
Read Hubspot data in UiPath Studio (workstation)
Here we will be reading Hubspot data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!
-
Open UiPath Studio.
-
Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
-
In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:
Simply select UiPath Studio option:
-
Start by creating a new project based on UiPath Process template:
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
HubspotDSNHubspotDSN
You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration. -
Once you do that, it's time to configure a SQL query:
Make sure, you enclose the query in double quotes! -
Proceed by adding a Write CSV activity after Run Query:
In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel. -
Once you do that, configure the added Write CSV, this will write Hubspot data to a CSV file:
-
It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
-
Finally, ensure there are no execution errors!
Run UiPath package using Orchestrator (via robot)
UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!
Publish process package from UiPath Studio
- First of all, open the UiPath process package we created in the previous step
-
Set the option that our process package Starts in Background:
-
We are ready to Publish it:
-
Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
-
Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:
Create robot in UiPath Orchestrator
-
First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
-
It's time to create a robot, which will run unattended packages:
-
But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
-
Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
-
Configure the machine to run in Production environment:
-
We are ready to Create new robot account in the new machine:
-
Let's make our robot to work only on background automations:
-
Continue by selecting newly created robot:
-
Select Shared folder, so that everyone in the team can benefit from it:
This is the folder where we published our UiPath process package "MyProcess" -
We are almost done!
We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator.
Let's leave this open for a while and see how we can do it in the next step.
Connect UiPath Assistant to Orchestrator
We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!
- Connect to a remote machine (where your UiPath process package will be running).
- Install UiPath Studio there.
- Then configure ODBC data source:
If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.
Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.
-
Continue by opening UiPath Assistant and going to Preferences:
-
Find Orchestrator Settings menu item and click it:
-
And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
-
Finally, we get rewarded for the hard work with the Connected as Unattended status:
Create and run UiPath process in Orchestrator
We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.
- First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
-
Then proceed by going to Process in Shared folder:
-
Continue by simply clicking on Add process button:
-
Select the process package we created in UiPath Studio:
-
Rest a while, and just hit Next, unless your package has requirements:
-
Then simply hit Create button:
-
But let's not stop here and Start the process by creating a job right away:
-
Use the same Production runtime we created before and hit Start:
-
We've reached the final step! In the CSV destination file or destination of your choice you should see Hubspot data:
Optional: Centralized data access via ZappySys Data Gateway
In some situations, you may need to provide Hubspot data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.
This configuration provides two primary advantages:
-
Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
-
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.
Data Gateway Local ODBCdata sourceSimple configuration Installation Single machine Per machine Connectivity Local and remote Local only Connections limit Limited by License Unlimited Central data access Central access control More flexible cost To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in UiPath (client-side) to connect to it.
Let's not wait and get going!
Create Hubspot data source in the gateway
In this section we will create a data source for Hubspot in the Data Gateway. Let's follow these steps to accomplish that:
-
Search for
gatewayin the Windows Start Menu and open ZappySys Data Gateway Configuration:
-
Go to the Users tab and follow these steps to add a Data Gateway user:
- Click the Add button
-
In the Login field enter a username, e.g.,
john - Then enter a Password
- Check the Is Administrator checkbox
- Click OK to save
-
Now we are ready to add a data source:
- Click the Add button
- Give the Data source a name (have it handy for later)
- Then select Native - ZappySys API Driver
- Finally, click OK
HubspotDSNZappySys API Driver
-
When the ZappySys API Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the Hubspot ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - HubspotRead and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.HubspotDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then go to Data Gateway configuration and in data source configuration window click Load settings:
HubspotDSNZappySys API Driver - Configuration [Version: 2.0.1.10418]ZappySys API Driver - HubspotRead and write HubSpot data effortlessly. Integrate, manage, and automate contacts, companies, deals, and tickets — almost no coding required.HubspotDSN
-
Once a window opens, just paste the settings by pressing
CTRL+Vor by clicking right mouse button and then Paste option.
-
Open ODBC data source configuration and click Copy settings:
-
Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:
- This will initially allow all inbound traffic.
- Click Edit IP filters to restrict access to specific IP addresses or ranges.
-
Crucial Step: After creating or modifying the data source, you must:
- Click the Save button to persist your changes.
- Hit Yes when prompted to restart the Data Gateway service.
This ensures all changes are properly applied:
Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.
Create ODBC data source to connect to the gateway
In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from UiPath. To achieve that, let's perform these steps:
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:
ODBC Driver 17 for SQL Server
If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version. -
Then set a Name for the data source (e.g.
Gateway) and the address of the Data Gateway:ZappySysGatewayDSNlocalhost,5000
Make sure you separate the hostname and port with a comma, e.g.localhost,5000. -
Proceed with the authentication part:
- Select SQL Server authentication
-
In the Login ID field enter the user name you created in the Data Gateway, e.g.,
john - Set Password to the one you configured in the Data Gateway
-
Then set the default database property to
HubspotDSN(the one we used in the Data Gateway):HubspotDSNHubspotDSN
Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step). -
Continue by checking the Trust server certificate option:
-
Once you do that, test the connection:
-
If the connection is successful, everything is good:
-
Done!
We are ready to move to the final step. Let's do it!
Access data in UiPath via the gateway
Finally, we are ready to read data from Hubspot in UiPath via the Data Gateway. Follow these final steps:
-
Go back to UiPath.
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
ZappySysGatewayDSNZappySysGatewayDSN
You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration. -
Read the data the same way we discussed at the beginning of this article.
-
That's it!
Now you can connect to Hubspot data in UiPath via the Data Gateway.
If you are asked for authentication details, use Database authentication, SQL authentication or Basic authentication option and enter the credentials you used when configuring the Data Gateway, e.g.johnand your password.Supported Hubspot Connector actions
Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Hubspot operations directly in UiPath, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:
- Archive Companies
- Archive Contacts
- Archive Deals
- Archive Line Items
- Archive Products
- Archive Quotes
- Archive Tickets
- Create Companies
- Create Contacts
- Create Deals
- Create Line Items
- Create Products
- Create Quotes
- Create Tickets
- Get Companies
- Get Company By ID
- Get Company Properties
- Get Contact By ID
- Get Contact Properties
- Get Contacts
- Get Deal By ID
- Get Deal Properties
- Get Deals
- Get Line Item By ID
- Get Line Item Properties
- Get Line Items
- Get Owners
- Get Product By ID
- Get Product Properties
- Get Products
- Get Quote By ID
- Get Quotes
- Get Quotes Properties
- Get Ticket By ID
- Get Tickets
- Get Tickets Properties
- Search Companies
- Search Contacts
- Search Deals
- Search LineItems
- Search Products
- Search Quotes
- Search Tickets
- Update Companies
- Update Contacts
- Update Deals
- Update Line items
- Update Products
- Update Quotes
- Update Tickets
- Upload File from Local Disk
- Make Generic REST API Request
- Make Generic REST API Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Hubspot in UiPath and integrate data without writing complex code — all of this was powered by Hubspot ODBC Driver.
Download ODBC PowerPack 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):
Explore UiPath connectors
AllBig Data & NoSQLDatabaseCRM & ERPMarketingCollaborationCloud StorageReportingCommerceAPI & FilesMore Hubspot integrations
AllData IntegrationDatabaseBI & ReportingProductivityProgramming LanguagesAutomation & ScriptingODBC applications