HubSpot

This article outlines the integration with the HubSpot connector, enabling metadata management through features such as crawling, sample profiling, data preview, and manual lineage. The connector crawls HubSpot CRM standard and custom objects, including schemas, tables, and columns, and maps the retrieved metadata to the corresponding OvalEdge assets.

This connector connects to HubSpot CRM using REST APIs over HTTPS through HubSpot CRM API v3. It authenticates using a HubSpot Private App access token (Bearer token) with the required API scopes to access schemas, CRM objects, properties, and metadata required for crawling and data preview.

Overview

Connector Details

Connector Category	Application
OvalEdge Release Supported	Release6.3.4 and later
Connectivity [How the connection is established with HubSpot]	REST APIs over HTTPS using HubSpot CRM API v3 with Bearer token authentication.
Verified HubSpot Versions	HubSpot CRM API v3

Connector Features

Feature	Availability
Crawling	✅
Profiling	❌
Sample Profiling	✅
Query Sheet	❌
Data Preview	✅
Auto Lineage	❌
Manual Lineage	✅
Secure Authentication via Credential Manager	✅
Data Quality	❌
DAM (Data Access Management)	❌
Bridge	✅

Metadata Mapping

The following objects are crawled from HubSpot and mapped to the corresponding UI assets.

HubSpot Object	HubSpot Attribute	OvalEdge Attribute	OvalEdge Category	OvalEdge Type
Schema	Schema name	Schema	Databases	Schema
Schema	Schema comment	Source Description	Databases	Schema
Table	CRM Object Name	Table	Tables	table
Table	objectTypeId	Table ID	Tables	table
Table	Table Comments	Source Description	Descriptions	Source Description
Columns	name	Column	Table Columns	-
Columns	label	Title	Table Columns	-
Columns	type	Column Type	Table Columns	-
Columns	description	Source Description	Table Columns	-
Columns	Column Position	Column Position	Table Columns	-
Columns	required	Nullable	Table Columns	-
Custom Objects	name	Table	Tables	table
Custom Objects	objectTypeId	Table ID	Tables	table
Custom Objects	properties	Columns	Table Columns	-

Set up a Connection

Prerequisites

The prerequisites to establish a connection:

Service Account User Permissions

It is recommended to use a dedicated service account to establish the connection to the data source, configured with the following minimum set of permissions.

👨‍💻 Who can provide these permissions? The HubSpot administrator grants these permissions, since users may not have sufficient access to assign them.

Operations	Objects	Sys Tables	Access Permissions
Crawling	Schema	GET /crm/v3/schemas	crm.schemas.custom.read
Crawling	Schema	GET /crm/v3/objects/{objectType}	crm.schemas.custom.read
Crawling	Table Columns	GET /crm/v3/properties/{objectType}	crm.schemas.{objectType}.read
Crawling	Table Columns	GET /crm/v3/schemas	crm.schemas.{objectType}.read
Profiling	Data Preview	GET /crm/v3/objects/{objectType}	crm.objects.{objectType}.read
Profiling	Data Preview	GET /companies/v2/companies/{id}	crm.objects.companies.read
Profiling	Data Preview	GET /contacts/v1/contact/vid/{id}/profile	crm.objects.contacts.read
Profiling	Data Preview	GET /deals/v1/deal/{id}	crm.objects.deals.read
Profiling	Data Preview	GET /crm-objects/v1/objects/{type}/{id}	crm.objects.products.read / crm.objects.tickets.read
Profiling	Data Preview	GET /crm/v3/objects/{objectTypeId}	crm.objects.custom.read

Connection Configuration Steps

Users must have the Connector Creator role to configure a new connection.

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for HubSpot, and enter the required parameters.

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name	Description
Connector Type	By default, "SAP ASE (Adaptive Server Enterprise)" is displayed as the selected connector type.
Credential Manager*	Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection. Supported Credential Managers: OE Credential Manager AWS Secrets Manager HashiCorp Azure Key Vault For more details, click here.
Connector Name*	Enter a unique name for the HubSpot connection (Example: "HubSpot_Prod").
Connector Environment	Select the environment (Example: PROD, STG) configured for the connector. For more details, click here.
Connector Description	Enter the description related to the connector.
HubSpot API Key*	Enter the HubSpot Private App Access Token used to authenticate with the HubSpot CRM API.
Proxy Enabled*	Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.
Plugin Server	Enter the server’s name when running as a plugin server.
Plugin Port	Enter the port number on which the plugin is running.

Default Governance Roles
Default Governance Roles*	Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.
Admin Roles
Admin Roles*	Select one or more users from the drop-down list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.
No of Archive Objects
No Of Archive Objects*	This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive. Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.
Bridge
Select Bridge*	If applicable, select the bridge from the drop-down list. The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.

1. After entering all connection details, the following actions can be performed:

   1. Click Validate to verify the connection.

   2. Click Save to store the connection for future use.

   3. Click Save & Configure to apply additional settings before saving.

2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

To perform crawl and profile operations, users must be assigned the Integration Admin role.

The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.

1. Navigate to the Connectors page and click Crawl/Profile.

2. Select the schemas to crawl.

3. The Crawl option is selected by default. To perform both operations, select the Crawl & Profile radio button.

4. Click Run to collect metadata from the connected source and load it into the Data Catalog.

5. After a successful crawl, the information appears in the Data Catalog > Databases tab.

The Schedule checkbox allows automated crawling for a selected timeframe, from a minute to a year.

1. Click the Schedule checkbox to enable the Select Period drop-down.

2. Select a time period for the operation from the drop-down menu.

3. Click Schedule to initiate metadata collection from the connected source.

4. The system will automatically execute the selected operation (Crawl or Crawl & Profile) at the scheduled time.

Other Operations

The Connectors page provides a centralized view of all configured connectors and their health status.

Managing connectors includes:

• Connectors Health: Displays the current status of each connector, with a green icon for active connections and a red icon for inactive connections, helping monitor connectivity to data sources.

• Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

Nine Dots Menu Options:

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

• Edit Connector: Update and revalidate the data source.

• Validate Connector: Check the integrity of the connection.

• Settings: Modify connector settings.

  • Crawler: Configure data extraction.

  • Profiler: Customize data profiling rules and methods.

  • Access Instructions: Add notes on how data can be accessed.

  • Business Glossary Settings: Manage term associations at the connector level.

  • Others: Configure notification recipients for metadata changes.

• Delete Connector: Remove a connector with confirmation.

For more details on connector settings, click here.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

S. No.	Error Message	Error Description & Resolution
1	Failed to authenticate with HubSpot	Description: Authentication failed because the HubSpot Private App access token is invalid, expired, or missing the required permissions. Resolution: Verify that the HubSpot Private App access token is valid and has not expired. Ensure the required API scopes are granted (such as contact, company, deal, product, ticket, and custom schema read scopes). Confirm the access token is entered correctly in the HubSpot API Key field.
2	JSON response contains error from HubSpot API	Description: The HubSpot API returned an error in the JSON response. This may occur due to insufficient permissions, API rate limits, or invalid object requests. Resolution: Review the error message returned in the API response to identify the exact cause. Verify that the access token includes all required scopes and that the requested object type is valid. If a 429 (Rate Limit Exceeded) error occurs, wait before retrying the request or reduce the request frequency.
3	Failed to get remote tables or columns	Description: The connector could not retrieve metadata because the authenticated user does not have sufficient access or the requested objects are unavailable. Resolution: Verify that the API token has read access to the required HubSpot CRM objects. For custom objects, ensure the crm.schemas.custom.read scope is enabled. Confirm that the required custom objects exist in the connected HubSpot account.
4	Data preview shows incomplete columns	Description: Some columns may not appear in the preview because HubSpot returns only properties that contain data in the API response. Resolution: Re-crawl the table to refresh the metadata and column information. Verify that the source object contains values for the expected properties. If the issue persists, validate that the connector successfully retrieved the complete property metadata from HubSpot.
5	Enumeration properties not profiled	Description: Enumeration data types are intentionally excluded from profiling because they are included in the connector's skipped data type configuration. Resolution: Verify whether the enumeration data type is configured in the skipDataTypeForProfile list. Note that excluding enumeration properties from profiling is the expected behavior. Modify the profiling configuration only if enumeration profiling is required and supported.
6	Connection timeout or proxy errors	Description: The connector is unable to establish a connection to the HubSpot API due to network restrictions or proxy configuration issues. Resolution: Enable Proxy Enabled and configure the appropriate proxy settings if a corporate proxy is used. Ensure outbound HTTPS access to api.hubapi.com over port 443 is allowed through the firewall or proxy. Verify network connectivity and retry the connection after updating the proxy or firewall configuration.

---

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA