Hubspot Connector for SQL Server
In this article you will learn how to integrate Using Hubspot Connector you will be able to connect, read, and write data from within SQL Server. 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
|
Video Tutorial - Integrate Hubspot data in SQL Server
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
Hubspot integration in SQL Server - How to configure connection for
Hubspot - Features about
API Driver (Authentication / Query Language / Examples / Driver UI) - Using
Hubspot Connection in SQL Server
Create Data Source in ZappySys Data Gateway based on API Driver
-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
-
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.
HubspotDSN
-
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 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.
Read data in SQL Server from the ZappySys Data Gateway
-
To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
-
Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
-
Optional: Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).
You need to enable RPC Out if you plan to use
EXEC(...) AT [MY_LINKED_SERVER_NAME]
rather than OPENQUERY.
If don't enabled it, you will encounter theServer 'MY_LINKED_SERVER_NAME' is not configured for RPC
error.Query Example:
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
If you plan to use
'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]'
in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
If don't disabled it, you will encounter theThe operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction.
error.Query Example:
Insert Into dbo.Products EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
-
Finally, open a new query and execute a query we saved in one of the previous steps:
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');
Create Linked Server using Code
In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'HubspotDSN'USE [master] GO --/////////////////////////////////////////////////////////////////////////////////////// --Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server --/////////////////////////////////////////////////////////////////////////////////////// //Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD //Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server //Replace Port 5000 if you configured gateway on a different port --1. Configure your gateway service as per this article https://zappysys.com/links?id=10036 --2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express --Uncomment below if you like to drop linked server if it already exists --EXEC master.dbo.sp_dropserver @server=N'LS_HubspotDSN', @droplogins='droplogins' --3. Create new linked server EXEC master.dbo.sp_addlinkedserver @server = N'LS_HubspotDSN' --Linked server name (this will be used in OPENQUERY sql , @srvproduct=N'' ---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)--- , @provider=N'SQLNCLI11' ---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)--- --, @provider=N'MSOLEDBSQL' , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running , @provstr=N'Network Library=DBMSSOCN;' , @catalog=N'HubspotDSN' --Data source name you gave on Gateway service settings --4. Attach gateway login with linked server EXEC master.dbo.sp_addlinkedsrvlogin @rmtsrvname=N'LS_HubspotDSN' --linked server name , @useself=N'False' , @locallogin=NULL , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name , @rmtpassword='YOUR_GATEWAY_PASSWORD' --enter your Gateway user's password GO --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY EXEC sp_serveroption 'LS_HubspotDSN', 'rpc', true; EXEC sp_serveroption 'LS_HubspotDSN', 'rpc out', true; --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement EXEC sp_serveroption 'LS_HubspotDSN', 'remote proc transaction promotion', false; --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds) --EXEC sp_serveroption 'LS_HubspotDSN', 'query timeout', 1200; GO
Firewall settings
So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.
Method-1 (Preferred)If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.
- Search for gateway in start menu and open ZappySys Data Gateway.
- Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it).
- Search for Windows Firewall Advanced Security in start menu.
- Under Inbound Rules > Right click and click [New Rule] >> Click Next
- Select Port on Rule Type >> Click Next
- Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
- Select Profile (i.e. Private, Public) >> Click Next
- Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
- Click OK to save the rule
OPENQUERY vs EXEC (handling larger SQL text)
So far we have seen examples of using OPENQUERY. It allows us to send pass-through query at remote server. The biggest limitation of OPENQUERY is it doesn't allow you to use variables inside SQL so often we have to use unpleasant looking dynamic SQL (Lots of tick, tick …. and escape hell). Well there is good news. With SQL 2005 and later you can use
EXEC(your_sql) AT your_linked_server
syntax . Disadvantage of EXEC AT is you cannot do SELECT INTO like OPENQUERY. Also you cannot perform JOIN like below in EXEC AT
However you can always doSELECT a.* FROM OPENQUERY([ls_HubspotDSN],'select * from Customers') a JOIN OPENQUERY([ls_HubspotDSN],'select * from Orders') b ON a.CustomerId=b.CustomerId;
INSERT INTO SomeTable EXEC(…) AT your_linked_server
. So table must exists when you do that way. Here is how to use it. To useEXEC(..) AT {linked-server}
you must turn onRPC OUT
option. Notice how we used variable in SQL to make it dynamic. This is much cleaner than previous approach we saw.
Here is the difference between OPENQUERY vs EXEC approaches:USE [master] GO --Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD --Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server --Create new linked server EXEC master.dbo.sp_addlinkedserver @server = N'LS_HubspotDSN' --Linked server name (this will be used in OPENQUERY sql) , @srvproduct=N'' ---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)--- , @provider=N'SQLNCLI11' ---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)--- --, @provider=N'MSOLEDBSQL' , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running , @provstr=N'Network Library=DBMSSOCN;' , @catalog=N'HubspotDSN' --Data source name you gave on Gateway service settings --Attach gateway login with linked server EXEC master.dbo.sp_addlinkedsrvlogin @rmtsrvname=N'LS_HubspotDSN' --linked server name , @useself=N'False' , @locallogin=NULL , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name , @rmtpassword='YOUR_GATEWAY_PASSWORD' --enter your Gateway user's password GO --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY EXEC sp_serveroption 'LS_HubspotDSN', 'rpc', true; EXEC sp_serveroption 'LS_HubspotDSN', 'rpc out', true; --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement EXEC sp_serveroption 'LS_HubspotDSN', 'remote proc transaction promotion', false; --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds) --EXEC sp_serveroption 'LS_HubspotDSN', 'query timeout', 1200; GO
Fetching Tables / Columns using metadata stored procs
ZappySys Data Gateway emulates certains system procs you might find in real SQL Server. You can call using below syntax using 4-Parts syntaxexec [linked-server-name].[gateway-datasource-name].[DATA].sp_tables
Example:exec [linked-server-name].[gateway-datasource-name].[DATA].sp_columns_90 N'your-table-name'
//List all tables exec [ls_HubspotDSN].[HubspotDSN].[DATA].sp_tables //List all columns and its type for specified table exec [ls_HubspotDSN].[HubspotDSN].[DATA].sp_columns_90 N'Account'
Known Issues
Let's explore some common problems that can occur when using OPENQUERY or Data Gateway connectivity.
SQL Native Client 11.0 not visible in the Providers dropdown (Linked Server Creation)
If you are following some screenshots / steps from our article it might say use SQL Native Client to create Linked Server to ZappySys Gateway but for some users they dont see that driver entry in the dropdown. This is due to the fact that Microsoft has deprecated SQL Native Client OLEDB Driver (SQLNCLI and SQLNCLI11) going forward after SQL 2022. So you need to use [Microsoft OLE DB Driver for SQL Server] instead (MSOLEDBSQL). Please follow all other instructions except the driver type selection, use new suggested driver instead if you dont see SQL Native Client.
Error: The data is invalid
There will be a time when, you may encounter unexpected errors like the ones listed below. These can include:
OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Deferred prepare could not be completed.". OLE DB provider "SQLNCLI11" for linked server "Zs_Csv" returned message "Communication link failure". Msg 13, Level 16, State 1, Line 0 Session Provider: The data is invalid.
Possible Cause:There are few reasons for such error but below are two main reasons
-
If the query length exceeds 2000 characters, as shown below, you might encounter this error.
SELECT * FROM OPENQUERY(LS, '--some really long text more than 2000 chars--')
-
If a query contains multiple OPENQUERY statements for JOINs or UNIONs, as shown below, it might fail due to a MARS compatibility issue where the gateway doesn't support parallel queries on a single connection.
SELECT a.id, b.name from OPENQUERY(LS, 'select * from tbl1') a join OPENQUERY(LS, 'select * from tbl2') b on a.id=b.id
There are few ways to fix above error based on reason why you getting this error (i.e. Query Length issue OR JOIN/UNION in the same statement)
-
If your query has long SQL (more than 2000 chars ) then reduce SQL length using different techniques
- e.g. use SELECT * FROM MyTable rather than SELECT col1,col2… FROM MyTable
- Use Meta Option in WITH clause if you must use column name. (e.g. SELECT * FROM MyTable WITH(META=’c:\meta.txt’) this way you can define column in Meta file rather than SELECT query. Check this article
- Consider using EXECT (….) AT [Linked_Server_name] option rather than OPENQUERY so you can use very long SQL (See next section on EXEC..AT usecase)
-
Consider using Virtual Table / Stored Proc to wrap long SQL so your call is very small (where usp_GetOrdersByYear is custom proc created on ZappySys Driver UI)
SELECT * FROM OPENQUERY(LS, 'EXEC usp_GetOrdersByYear 2021')
-
If your query uses JOIN / UNION with multiple OPENQUERY in same SQL then use multiple Linked servers (one for each OPENQUERY clause) as below.
select a.id, b.name from OPENQUERY(LS_1, 'select * from tbl1') a join OPENQUERY(LS_2, 'select * from tbl2') b on a.id=b.id
Error: Unable to begin a distributed transaction (When INSERT + EXEC used)
If you try to use the EXEC statement to insert data into a table, as shown below, you might encounter the following error unless the MSDTC option is turned off.
INSERT INTO MyTable EXEC('select * from tbl') AT MyLinkedServer
"Protocol error in TDS stream" The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "ls_Json2" was unable to begin a distributed transaction. --OR-- The operation could not be performed because OLE DB provider "MSOLEDBSQL" for linked server "ls_Json" was unable to begin a distributed transaction.
Solution:
Method-1: Go to linked server properties | Server Options | Enable Promotion of Distributed Transaction | Change to false (Default is true)
Now your try your INSERT with EXEC AT and it should workMethod-2: Run the below command if you dont want to use UI
EXEC master.dbo.sp_serveroption @server=N'My_Linked_Server', @optname=N'remote proc transaction promotion', @optvalue=N'false'
Error: Cannot use OPENQUERY with JOIN / UNION
When you perform a JOIN or UNION ALL on the same Linked Server, it may fail to process sometimes because the Data Gateway doesn't support parallel query requests on the same connection. A workaround for that would be to create multiple linked servers for the same data source. Refer to the section above for the same workaround.
Error: Truncation errors due to data length mismatch
Many times, you may encounter truncation errors if a table column's length is less than the actual column size from the query column. To solve this issue, use the new version of Data Gateway and check the 'Use nvarchar(max) for string options' option found on the General Tab.
Performance Tips
Now, let's look at a few performance tips in this section.
Use INSERT INTO rather than SELECT INTO to avoid extra META request
We discussed some Pros and Cons of OPENQUERY vs EXEC (…) AT in previous section. One obvious advantage of EXEC (….) AT is it reduces number of requests to driver (It sends pass through query). With EXEC you cannot load data dynamically like SELECT INTO tmp FROM OPENQUERY. Table must exist before hand if you use EXEC.
INSERT INTO tmp_API_Report_Load(col1,col2) EXEC('select col1,col2 from some_api_table') AT [API-LINKED-SERVER] --OR-- INSERT INTO tmp_API_Report_Load(col1,col2) select col1,col2 from OPENQUERY([API-LINKED-SERVER], 'select col1,col2 from some_api_table')
The advantage of this method is that your query speed will increase because the system only calls the API once when you use EXEC AT. In contrast, with OPENROWSET, the query needs to be called twice: once to obtain metadata and once to retrieve the data.
Use Cached Metadata if possible
By default, most SQL queries sent to the Data Gateway need to invoke two phases: first, to get metadata, and second, to fetch data. However, you can bypass the metadata API call by supplying static metadata. Use the META property in the WITH clause, as explained in this article, to speed up your SQL queries.
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.Search CompaniesSearch companies using one or more filter conditions. Choose properties to include in the output. [Read more...]Parameter Description Properties Search ContactsSearch contacts using one or more filter conditions. Choose properties to include in the output. [Read more...]Parameter Description Properties Search TicketsSearch tickets using one or more filter conditions. Choose properties to include in the output. [Read more...]Parameter Description Properties Search DealsSearch deals using one or more filter conditions. Choose properties to include in the output. [Read more...]Parameter Description Properties Search ProductsSearch products using one or more filter conditions. Choose properties to include in the output. [Read more...]Parameter Description Properties Search LineItemsSearch LineItems using one or more filter conditions. Choose properties to include in the output. [Read more...]Parameter Description Properties Search QuotesSearch Quotes using one or more filter conditions. Choose properties to include in the output. [Read more...]Parameter Description Properties Get Contacts[Read more...]Parameter Description Properties Get Contact By ID[Read more...]Parameter Description Properties Get Contact PropertiesCreate ContactsUpdate ContactsArchive ContactsGet Deals[Read more...]Parameter Description Properties Get Deal PropertiesGet Deal By ID[Read more...]Parameter Description Properties Create DealsArchive DealsUpdate DealsGet Products[Read more...]Parameter Description Properties Get Product By ID[Read more...]Parameter Description Properties Get Product PropertiesCreate ProductsArchive ProductsUpdate ProductsGet Companies[Read more...]Parameter Description Properties Get Company By ID[Read more...]Parameter Description Properties Get Company PropertiesCreate CompaniesArchive CompaniesUpdate CompaniesGet Line Items[Read more...]Parameter Description Properties Get Line Item By ID[Read more...]Parameter Description Properties Get Line Item Properties[Read more...]Parameter Description Create Line Items[Read more...]Parameter Description Archive Line ItemsUpdate Line itemsGet Tickets[Read more...]Parameter Description Properties Get Ticket By ID[Read more...]Parameter Description Properties Get Tickets Properties[Read more...]Parameter Description Create TicketsArchive TicketsUpdate TicketsGet Quotes[Read more...]Parameter Description Properties Get Quote By ID[Read more...]Parameter Description Properties Get Quotes Properties[Read more...]Parameter Description Create QuotesArchive QuotesUpdate QuotesGet Owners[Read more...]Parameter Description OwnerId Upload File from Local DiskUploads local file to Hubspot CRM. This API requires files permission for the App (see scopes) [Read more...]Parameter Description Source File Path Specify a disk file path Target Folder Path Specify Target folder path. Partially optional field. One of folderPath or folderId must be specified. Path of the folder the file should be uploaded into. Uploading files into the root path “/” is highly discouraged. Target File Name (e.g. MyFile.xlsx) Specify file name you like to give AccessType Specify file access type Option Value PRIVATE PRIVATE PUBLIC_NOT_INDEXABLE PUBLIC_NOT_INDEXABLE PUBLIC_INDEXABLE PUBLIC_INDEXABLE Overwrite Specify wheather you like to overwrite target file if exists. If true this file with replace any existing files with the name, folder, and type. Note: If this is set to false, and the uploaded file matches the filename of an existing file in the same folder, the file will be uploaded with a number incremented filename (e.g. example_file.txt will become example_file-1.txt) Option Value false false true true DuplicateValidationStrategy Specify how to handle duplicate target file. Option Value NONE NONE REJECT REJECT RETURN_EXISTING RETURN_EXISTING DuplicateValidationScope Specify scope of duplicate validation. Option Value EXACT_FOLDER EXACT_FOLDER ENTIRE_PORTAL ENTIRE_PORTAL Generic RequestThis is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [Read more...]Parameter Description Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains Body Request Body content goes here IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract Option Value No filter Example1 $.store.books[*] Example2 (Sections Under Books) $.store.books[*].sections[*] Example3 (Equals) $.store.books[?(@author=='sam')] Example4 (Equals - Any Section) $..[?(@author=='sam')] Example5 (Not Equals - Any Section) $..[?(@author!='sam')] Example6 (Number less than) $.store.books[?(@.price<10)] Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam|bob/ )] Example8 (Regular Expression - Does Not Contain Pattern) $.store.books[?(@author=~ /^((?!sam|bob).)*$/ )] Example9 (Regular Expression - Exact Pattern Match) $.store.books[?(@author=~ /^sam|bob$/ )] Example10 (Regular Expression - Starts With) $.store.books[?(@author=~ /^sam/ )] Example11 (Regular Expression - Ends With) $.store.books[?(@author=~ /sam$/ )] Example12 (Between) $.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )] Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair Generic Request (Bulk Write)This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [Read more...]Parameter Description Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract Headers Headers for Request. To enter multiple headers use double pipe (||) or new line after each {header-name}:{value} pair Hubspot Connector Examples for SQL Server 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 SQL Server and integrate data without any coding. Click here to Download Hubspot Connector for SQL Server 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 SQL Server Documentation
More integrations
Other application integration scenarios for Hubspot
Other connectors for SQL Server
Download Hubspot Connector for SQL Server DocumentationHow to connect Hubspot in SQL Server?
How to get Hubspot data in SQL Server?
How to read Hubspot data in SQL Server?
How to load Hubspot data in SQL Server?
How to import Hubspot data in SQL Server?
How to pull Hubspot data in SQL Server?
How to push data to Hubspot in SQL Server?
How to write data to Hubspot in SQL Server?
How to POST data to Hubspot in SQL Server?
Call Hubspot API in SQL Server
Consume Hubspot API in SQL Server
Hubspot SQL Server Automate
Hubspot SQL Server Integration
Integration Hubspot in SQL Server
Consume real-time Hubspot data in SQL Server
Consume real-time Hubspot API data in SQL Server
Hubspot ODBC Driver | ODBC Driver for Hubspot | ODBC Hubspot Driver | SSIS Hubspot Source | SSIS Hubspot Destination
Connect Hubspot in SQL Server
Load Hubspot in SQL Server
Load Hubspot data in SQL Server
Read Hubspot data in SQL Server
Hubspot API Call in SQL Server