> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/release8.2/connectors/connector-repositories/application/hubspot.md).

# 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.

<img src="/files/LwB6NPAoYcMniNtJTlqn" alt="" height="327" width="624">

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="370.33331298828125"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Application</td></tr><tr><td>OvalEdge Release Supported</td><td>Release6.3.4 and later</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with HubSpot]</p></td><td>REST APIs over HTTPS using HubSpot CRM API v3 with Bearer token authentication.</td></tr><tr><td>Verified HubSpot Versions</td><td>HubSpot CRM API v3</td></tr></tbody></table>

### 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**

{% hint style="warning" %}
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.
{% endhint %}

{% hint style="info" %}
**👨‍💻 Who can provide these permissions?** The HubSpot administrator grants these permissions, since users may not have sufficient access to assign them.
{% endhint %}

| 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

{% hint style="warning" %}
Users must have the Connector Creator role to configure a new connection.
{% endhint %}

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

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="219.66668701171875">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "SAP ASE (Adaptive Server Enterprise)" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul><p>For more details, click <a href="https://docs.ovaledge.com/connectors/additional-requirements/credential-manager-configuration">here</a>.</p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the HubSpot connection              </p><p>(Example: "HubSpot_Prod").</p></td></tr><tr><td>Connector Environment</td><td><p>Select the environment (Example: PROD, STG) configured for the connector.</p><p>For more details, click <a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/prerequisites#connector-environment">here</a>.</p></td></tr><tr><td>Connector Description</td><td>Enter the description related to the connector.</td></tr><tr><td>HubSpot API Key*</td><td>Enter the <strong>HubSpot Private App Access Token</strong> used to authenticate with the HubSpot CRM API.</td></tr><tr><td>Proxy Enabled*</td><td>Select <strong>Yes</strong> to route API calls through a proxy server. Select <strong>No</strong> to bypass the proxy and connect directly.</td></tr><tr><td>Plugin Server</td><td>Enter the server’s name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="220.3333740234375"></th><th></th></tr></thead><tbody><tr><td><strong>Default Governance Roles</strong></td><td></td></tr><tr><td>Default Governance Roles*</td><td>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.</td></tr><tr><td><strong>Admin Roles</strong></td><td></td></tr><tr><td>Admin Roles*</td><td>Select one or more users from the drop-down list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr><tr><td><strong>No of Archive Objects</strong></td><td></td></tr><tr><td>No Of Archive Objects*</td><td><p>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.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr><tr><td><strong>Bridge</strong></td><td></td></tr><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

2. 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.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="info" %}
To perform crawl and profile operations, users must be assigned the Integration Admin role.
{% endhint %}

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.&#x20;
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.&#x20;
  * **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](https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings).

### 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.

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

***

&#x20;Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ovaledge.com/release8.2/connectors/connector-repositories/application/hubspot.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.