Hubspot Connector for PowerShellHubspot 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! In this article you will learn how to quickly and efficiently integrate Hubspot data in PowerShell without coding. We will use high-performance Hubspot Connector to easily connect to Hubspot and then access the data inside PowerShell. Let's follow the steps below to see how we can accomplish that! Hubspot Connector for PowerShell is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Hubspot in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Hubspot using PowerShell we first need to create a DSN (Data Source) which will access data from Hubspot. We will later be able to read data using PowerShell. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
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.
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]
Steps how to get and use Hubspot credentials
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!
Fill in all required parameters and set optional parameters if needed:
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 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]
Steps how to get and use Hubspot credentials
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!
Fill in all required parameters and set optional parameters if needed:
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):
Deprecated authentication method. Use [Private app] instead. [API reference]
Steps how to get and use Hubspot credentials
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!
Fill in all required parameters and set optional parameters if needed:
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 - HubspotHubspot 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!HubspotDSNStart 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 PowerShell 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 PowerShell:
ZappySys API Driver - HubspotHubspot 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!HubspotDSNSELECT * FROM Companies --Where Id=123
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword 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 PowerShell
Sometimes, you need to quickly access and work with your Hubspot data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:
Viewing data in a terminal- Quickly peek at Hubspot data
- Monitor data constantly in your console
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!
Reading individual fields
- Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Then simply follow these instructions:
"DSN=HubspotDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=HubspotDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual Hubspot fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }
Access specific Hubspot table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]
DataTable.Rows
property in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in Hubspot. -
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:
"DSN=HubspotDSN"Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=HubspotDSN" $query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Display data in the console foreach ($row in $table.Rows) { $line = "" foreach ($column in $table.Columns) { $value = $row[$column.ColumnName] # Let's handle NULL values if ($value -is [DBNull]) { $value = "(NULL)" } $line += $value + "`t" } Write-Host $line }
You can limit the numbers of lines to retrieve by using aLIMIT
keyword in the query, e.g.:SELECT * FROM Customers LIMIT 10
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - HubspotHubspot 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!HubspotDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"
But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
- Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
This feature requires ODBC PowerPack v1.9.0 or later.Write Hubspot data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query $connectionString = "DSN=HubspotDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Export table data to a file $table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force
Save data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file $table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force
Save data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file $table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
Check useful PowerShell cmdlets other thanConvertTo-Csv
,ConvertTo-Json
, andConvertTo-Html
for other data manipulation scenarios.Actions supported by Hubspot Connector
Learn how to perform common Hubspot actions directly in PowerShell with these how-to guides:
- 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
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Hubspot in PowerShell and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Hubspot, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Hubspot Connector for PowerShell and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Hubspot Connector for PowerShell Documentation
More integrations
Other connectors for PowerShell
AllBig Data & NoSQLDatabaseCRM & ERPMarketingCollaborationCloud StorageReportingCommerceAPI & FilesOther application integration scenarios for Hubspot
AllData IntegrationDatabaseBI & ReportingProductivityProgramming LanguagesAutomation & ScriptingODBC applicationsHow to connect Hubspot in PowerShell?
How to get Hubspot data in PowerShell?
How to read Hubspot data in PowerShell?
How to load Hubspot data in PowerShell?
How to import Hubspot data in PowerShell?
How to pull Hubspot data in PowerShell?
How to push data to Hubspot in PowerShell?
How to write data to Hubspot in PowerShell?
How to POST data to Hubspot in PowerShell?
Call Hubspot API in PowerShell
Consume Hubspot API in PowerShell
Hubspot PowerShell Automate
Hubspot PowerShell Integration
Integration Hubspot in PowerShell
Consume real-time Hubspot data in PowerShell
Consume real-time Hubspot API data in PowerShell
Hubspot ODBC Driver | ODBC Driver for Hubspot | ODBC Hubspot Driver | SSIS Hubspot Source | SSIS Hubspot Destination
Connect Hubspot in PowerShell
Load Hubspot in PowerShell
Load Hubspot data in PowerShell
Read Hubspot data in PowerShell
Hubspot API Call in PowerShell