HubSpot

The HubSpot connector enables Omni to index and search content from your HubSpot CRM, including contacts, companies, deals, tickets, and engagement activities.

​

Overview

​

What Gets Indexed

​

How It Works

1. A HubSpot app access token provides read-only API access
2. The connector syncs CRM objects and engagement activities
3. Full sync mode indexes all accessible records

​

Prerequisites

Before setting up the HubSpot connector, ensure you have:

• HubSpot account with API access (Professional or Enterprise plan recommended)
• A HubSpot developer account to create and install an app

​

Setup

​

Step 1: Create a HubSpot App

Create an app on HubSpot’s developer platform. See HubSpot’s app creation guide for full instructions.

1. Install the HubSpot CLI and run hs project create
2. Choose App as the project type
3. Select static token authentication (for single-account access)

​

Step 2: Configure Scopes

Add the following scopes to your app’s app-hsmeta.json under requiredScopes:

​

Step 3: Install and Get Your Access Token

1. Upload your app with hs project upload
2. In HubSpot, go to the project’s Distribution tab and install the app on your account
3. Copy the access token from the app settings

​

Step 4: Connect in Omni

1. Navigate to Settings → Integrations in Omni
2. Find HubSpot and click Connect
3. Enter your access token
4. Click Connect
5. Click Configure against the Hubspot integration, enable it and click Save Configuration. This will automatically trigger the initial sync.

Using a Legacy Private App instead

If you have an existing legacy Private App, its access token will also work. However, HubSpot recommends the new developer platform for new integrations. To create a legacy Private App:

1. Go to Settings → Integrations → Private Apps
2. Click Create a private app and configure the same scopes listed above
3. Copy the access token (starts with pat-na1-) and use it in the Omni connection step

​

Managing the Integration

​

Viewing Sync Status

Navigate to Settings → Integrations → HubSpot to view:

• Last sync time
• Number of indexed records by type
• Any sync errors

​

Sync Behavior

The HubSpot connector currently supports full sync mode:

• Syncs all accessible CRM objects and engagements
• Processes records in batches of 100 (HubSpot API limit)
• Handles rate limiting automatically with exponential backoff

​

Record Properties

The connector fetches specific properties for each object type. All object types include hubspot_owner_id for ownership tracking.

Indexed properties by object type

CRM Objects

Object Type	Properties
Contacts	firstname, lastname, email, phone, company, jobtitle, lifecyclestage
Companies	name, domain, industry, phone, numberofemployees, annualrevenue
Deals	dealname, amount, pipeline, dealstage, closedate, hs_deal_stage_probability
Tickets	subject, content, hs_ticket_priority, hs_pipeline, hs_pipeline_stage

All CRM objects also include: hubspot_owner_id, createdate, hs_lastmodifieddateEngagement Activities

Object Type	Properties
Calls	hs_call_title, hs_call_body, hs_call_duration, hs_call_direction
Emails	hs_email_subject, hs_email_text, hs_email_html, hs_email_direction
Meetings	hs_meeting_title, hs_meeting_body, hs_meeting_start_time, hs_meeting_end_time
Notes	hs_note_body
Tasks	hs_task_subject, hs_task_body, hs_task_status, hs_task_priority

All engagement activities also include: hubspot_owner_id, hs_timestamp, hs_createdate, hs_lastmodifieddate

​

Removing the Integration

1. Navigate to Settings → Integrations → HubSpot
2. Click Remove
3. Optionally, uninstall the app in HubSpot:
   • Go to your project’s Distribution tab
   • Uninstall the Omni app from your account

​

Security Considerations

• Read-only access: The access token only has read permissions
• Token security: Access tokens should be treated like passwords
• Token rotation: Rotate tokens periodically for security from your app settings
• Data visibility: All users can search indexed HubSpot records (no per-user permissions)

​

What’s Next