Hubspot Connector for Python
In this article you will learn how to integrate Using Hubspot Connector you will be able to connect, read, and write data from within Python. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
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 Python we first need to create a DSN (Data Source) which will access data from Hubspot. We will later be able to read data using Python. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
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.
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
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 Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... 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)
Fill in all required parameters and set optional parameters if needed:
HubspotDSNHubspotUser Credentials (3-Legged) [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 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... 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
Fill in all required parameters and set optional parameters if needed:
HubspotDSNHubspotAPI Key in URL (Deprecated) [Http]https://api.hubapi.comRequired 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... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Read data in Python
Using ODBC DSN
-
Python code to get the data:
HubspotDSN') -
When you run the code it will make the API call and read the data:
-
Here is Python program's code in text format:
import pyodbc conn = pyodbc.connect('DSN=HubspotDSN') cursor = conn.cursor() #execute query to fetch data from API service cursor.execute("SELECT id,title FROM products") row = cursor.fetchone() while row: print(row) row = cursor.fetchone() ##For loop example #for row in cursor: # print(row)
Using a full ODBC connection string
If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - HubspotHubpost 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 in your Python code use Connection String when initializing OdbcConnection object, for example:
conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')
How to install `pyodbc` in the Python?
You would need to install pyodbc
in Python if you intend to establish connections to databases that support ODBC (Open Database Connectivity). This module facilitates communication between Python applications and various database management systems, enabling you to perform operations such as querying, retrieving data, and managing databases. Here's how you can install pyodbc
in Python:
Installation Steps:
Ensure you have Python installed on your system. If not, download it from the official Python website and follow the installation instructions.
Open your terminal or command prompt.
-
Use the following command to install
pyodbc
using pip, the Python package installer:python -m pip install "pyodbc"
Make sure you have a stable internet connection and the necessary permissions to install Python packages.
Reasons to Install:
- If pyodbc is not installed, your Python script will generate the following error:
"ModuleNotFoundError: No module named 'pyodbc'"
. Database Connectivity:
pyodbc
allows Python to connect to various databases that support ODBC, such as Microsoft SQL Server, PostgreSQL, MySQL, and more.Data Operations: It facilitates the execution of SQL queries, retrieval of data, and other database operations from within Python scripts.
Cross-Platform Support:
pyodbc
is designed to work across different operating systems, including Windows, macOS, and various Linux distributions.Simplicity and Efficiency: The module provides an intuitive interface for managing database transactions and connections, simplifying the process of working with databases in Python.
By installing pyodbc
, you can seamlessly integrate your Python applications with a wide range of ODBC-supported databases, enabling efficient and effective data management and analysis.
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
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
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
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>';
-
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';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
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.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
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'
-
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"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Hubspot Connector
Hubspot Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|
Parameter | Description |
---|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|---|
Properties |
|
Parameter | Description |
---|
Parameter | Description |
---|---|
OwnerId |
|
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Source File Path |
|
||||||||
Target Folder Path |
|
||||||||
Target File Name (e.g. MyFile.xlsx) |
|
||||||||
AccessType |
|
||||||||
Overwrite |
|
||||||||
DuplicateValidationStrategy |
|
||||||||
DuplicateValidationScope |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Hubspot Connector Examples for Python Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Get companies [Read more...]
Gets companies
SELECT * FROM Companies --Where Id=123
Get contacts [Read more...]
Gets contacts
SELECT * FROM Contacts --Where Id=123
Get contact by Id [Read more...]
Gets contact by Id
SELECT * FROM Contacts Where Id=51
Get contact by email (search) [Read more...]
Gets contacts
SELECT Id
, IsArchived
, CreatedAt
, UpdatedAt
, email
, firstname
, lastname
, company_size
--, custom_checkbox
--, custom_multi_select
--, custom_number
--, custom_pickuser
--, custom_richtext
--, custom_string
--, custom_string_multi
FROM search_contacts
With(SearchFilters='[ {"propertyName": "email", "operator": "EQ", "value": "bh@hubspot.com" } ]')
Get deals [Read more...]
Gets deals
SELECT * FROM Deals --Where Id=123
Get line items [Read more...]
Gets line items
SELECT * FROM LineItems --Where Id=123
Get owners [Read more...]
Gets owners
SELECT * FROM Owners
Get products [Read more...]
Gets products
SELECT * FROM Products --Where Id=123
Get tickets [Read more...]
Gets tickets
SELECT * FROM Tickets
Get quotes [Read more...]
Gets quotes
SELECT * FROM Quotes
Generic Request (Company Search API Example) [Read more...]
This example shows how to invoke generic request when connector file doesnt have specific EndPoint / Table you like to query. This example invokes search endpoint but you can call any valid API endpoint GET/POST etc with this method
SELECT *
FROM generic_request
WITH(
Url='crm/v3/objects/companies/search'
,Filter='$.results[*]'
,RequestContentTypeCode='ApplicationJson'
,RequestMethod='POST'
,RequestData='{
"filters": [ {"propertyName": "hs_lastmodifieddate", "operator": "GT", "value": "<<yearstart-1y||unix_timestamp_ms,FUN_TO_DATE>>" } ],
"properties": ["address","city","state"]
}'
)
Upload File (Generic Request Example) [Read more...]
This example shows how to upload a file using generic request. You might have to add file-manager-permission to your OAuth App else you might get message=This oauth-token (CJT87I6) does not have proper permissions! (requires any of [file-manager-access]). For more information please refer to this link https://developers.hubspot.com/docs/api/files/files
SELECT *
FROM generic_request
WITH(
Url='filemanager/api/v3/files/upload'
, RequestMethod='POST'
, Filter ='$.objects[*]'
, Body='file=@c:\temp\dump.png
folderPath=/
fileName=my_dump.png
options={"access": "PRIVATE", "overwrite": true}'
, IsMultiPart='True'
, Meta='id:long; name:string; title:string; url: string; type:string; size:long; friendly_url:string; meta.allows_anonymous_access:string; meta.indexable:bool'
)
Insert into Contacts [Read more...]
Inserts contacts
INSERT INTO Contacts(email, firstname, lastname,custom_checkbox, custom_date, custom_number)
VALUES ('john.doe@abc.com', 'John', 'Doe','true','2023-01-01', 100.55)
Update Contacts [Read more...]
Updates contacts in your account
UPDATE Contacts
SET firstname = 'Brian'
,lastname = 'Halligan (Sample Contact)'
--,custom_number=12.12
--,custom_date='2023-01-01'
--,custom_string='My Test<<FUN_NOW>>'
--,custom_richtext='<p><span style="color: #b5b5b5;">##-Please reply-##</span></p>'
--,custom_multi_select='Blue;Yellow;Black'
--,custom_pickuser=45581955
--,custom_dropdown='BB'
--,custom_checkbox='true'
WHERE Id = 51
Delete a contact [Read more...]
Deletes a contact
DELETE FROM Contacts Where Id=1234
Create multiple records - (BULK read / write from external source) [Read more...]
This examples shows how to perform bulk update using SOURCE clause. It reads data from external system (in this example MS SQL Server) and sends data to Hubspot using Bulk API
INSERT INTO Contacts
SOURCE(
'MSSQL' --ODBC or OLEDB
,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
,'
''bob'' as firstname, ''rock'' as firstname, ''new-email1@abc.com'' as email
UNION
''sam'' as firstname, ''smith'' as firstname, ''new-email2@abc.com'' as email
)
Delete multiple records - (BULK read / write from external source) [Read more...]
This examples shows how to perform bulk delete using SOURCE clause. It reads data from external system (in this example MS SQL Server) and sends data to Hubspot using Bulk API
DELETE FROM Contacts
SOURCE(
'MSSQL' --ODBC or OLEDB
,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
,'select 104897 as Id
UNION
select 104898 as Id'
)
Update multiple records - (BULK read / write from external source) [Read more...]
This examples shows how to perform bulk update using SOURCE clause. It reads data from external system (in this example MS SQL Server) and sends data to Hubspot using Bulk API
UPDATE Contacts
SOURCE(
'MSSQL' --ODBC or OLEDB
,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
,'select 104811 as Id, ''new-email1@abc.com'' as email
UNION
select 104812 as Id, ''new-email2@abc.com'' as email
)
Conclusion
In this article we discussed how to connect to Hubspot in Python and integrate data without any coding. Click here to Download Hubspot Connector for Python and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Hubspot Connector for Python
Documentation
More integrations
Other application integration scenarios for Hubspot
Other connectors for Python
Download Hubspot Connector for Python
Documentation
How to connect Hubspot in Python?
How to get Hubspot data in Python?
How to read Hubspot data in Python?
How to load Hubspot data in Python?
How to import Hubspot data in Python?
How to pull Hubspot data in Python?
How to push data to Hubspot in Python?
How to write data to Hubspot in Python?
How to POST data to Hubspot in Python?
Call Hubspot API in Python
Consume Hubspot API in Python
Hubspot Python Automate
Hubspot Python Integration
Integration Hubspot in Python
Consume real-time Hubspot data in Python
Consume real-time Hubspot API data in Python
Hubspot ODBC Driver | ODBC Driver for Hubspot | ODBC Hubspot Driver | SSIS Hubspot Source | SSIS Hubspot Destination
Connect Hubspot in Python
Load Hubspot in Python
Load Hubspot data in Python
Read Hubspot data in Python
Hubspot API Call in Python