HubSpot
This integration is currently in beta. Contact your MetaRouter support team to get started.
What Is HubSpot?
HubSpot is a customer relationship management (CRM) platform that provides a suite of tools designed to help businesses grow by improving their marketing, sales, customer service, and content management. Founded in 2006, HubSpot is known for its user-friendly interface and comprehensive features, which include email marketing, social media management, lead generation, analytics, and automation. The platform emphasizes inbound marketing, a strategy focused on attracting customers through valuable content and interactions. HubSpot also offers a range of integrations with other software, making it a versatile solution for businesses of all sizes.
Product Type: CRM
Integration Type: Starter Kit & ID Sync
Event Source Type: Web
Event Scope: Full-Funnel Events
Capabilities
- Sends server-side customer data events to HubSpot.
- Unlocks all customer data events and attributes for custom event mapping and transformation.
- Sends the HubSpot user token (
hubspotutk) collected via the sync to associate events with contacts. - Has no effect on website load latency.
Considerations
- Authentication uses a Bearer access token from a HubSpot private app.
- Each event must include either the
utk(HubSpot user token) or theemailassociated with the event for HubSpot to match it to a contact. - The user token (
utk) is collected via the HubSpot Tag sync. - All events pass through to HubSpot with the global fields applied. Only the Page event has event-specific mappings by default; other events can be given their own mappings in accordance with HubSpot's custom event documentation.
Identity Sync
- Sync Available: Yes
- Required for Starter Kit: Yes
- Prerequisites: HubSpot client ID (Hub ID)
- Documentation: See Additional HubSpot Sync Documentation
Sync Details
- Captures the
hubspotutkuser token used to match events to HubSpot contacts. - Used alongside or in place of the contact email for user matching.
- Without this sync, events may rely on email alone for contact matching.
Starter Kit Setup Guide
1. Deploy the HubSpot Tag Sync
- To collect the sync values (e.g.,
hubspotutk), you must implement a HubSpot Tag ID sync. Refer to the following documentation to complete the setup: HubSpot - ID Sync Guide.
2. Gather Credentials
- Create a Private App in HubSpot and generate an access token.
- Client ID (Hub ID): Found in your HubSpot account under your profile dropdown, or in the URL of your HubSpot dashboard (the numbers after
app.hubspot.com).
3. Add a HubSpot Integration
- From the integration library, add a HubSpot integration. Then, fill out the Connection Parameters:
| Connection Parameter | Description |
|---|---|
ACCESS_TOKEN | Token from creating a private app in HubSpot. |
4. Configure Event Mapping
- MetaRouter provides all of the event mappings that HubSpot integrations typically require. You may add custom events, parameters, or mappings in accordance with HubSpot's API documentation.
5. Deploy to Pipeline
- In the Pipelines tab, add your HubSpot integration.
- Select the correct integration revision.
- Click Add Integration to finalize deployment.
Event Mappings
Global
Global mappings will be applied to all events. If your parameter names do not match the Expected Inputs provided, you will need to overwrite the Inputs provided with your own.
| Output Key | Description | Expected Input |
|---|---|---|
objectId Required | String: ID of the object (contact record ID). | messageId |
occurredAt | String: Timestamp when the event occurred (ISO 8601). | timestamp |
utk * Required | String: HubSpot user token. | context.providers.hubSpotTag.hubspotutk |
email * Required | String: Email associated with the contact. | Expression – returns trimmed, lowercased traits.email when present |
*Either the utk or email associated with the event is required.
Event Specific
Page
| Output Key | Description | Expected Input |
|---|---|---|
eventName Required | String: Internal name of the event. | Enrichment – 'page_view_internal_name' |
properties.hs_page_content_type | String: Content type of the page. | Enrichment – 'STANDARD_PAGE' |
properties.hs_page_title | String: Title of the page. | properties.title |
Required & Recommended Identifiers
These identifiers must be mapped to HubSpot in order for successful user matching to occur. Without these IDs, any events sent to HubSpot will be rejected. For your convenience, required and recommended IDs are mapped as Global parameters to ensure they are added to every event.
| Attribute | Example | Sync Injector Required? |
|---|---|---|
objectId Required | 608051 | No |
utk * Required | 43e6f02f-a8d0-47bb-88d8-8a6b5c5f2e0d | Yes |
email * Required | [email protected] | No |
*Either the utk or email associated with the event is required.
Integration Validation
Coordinate with your HubSpot representative, or use the HubSpot dashboard, to confirm that events are being received and processed correctly on their backend.
Additional HubSpot Documentation
Updated 10 days ago