DocumentationExperience PlatformDestinations Guide

HubSpot connection

Last update: Thu Jul 04 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • User

HubSpot is a CRM platform with all the software, integrations, and resources you need to connect marketing, sales, content management, and customer service. It allows you to connect your data, teams, and customers on one CRM platform.

This Adobe Experience Platform destination leverages the HubSpot Contacts API, to update contacts within HubSpot from an existing Experience Platform audience after activation.

Instructions to authenticate to your HubSpot instance are further below, in the Authenticate to destination section.

Use cases use-cases

To help you better understand how and when you should use the HubSpot destination, here is a sample use case that Adobe Experience Platform customers can solve by using this destination.

HubSpot contacts store information about the individuals that interact with your business. Your team uses the contacts that exist in HubSpot to build the Experience Platform audiences. After sending these audiences to HubSpot, their information is updated and each contact is assigned a property with its value as the audience name that indicates which audience the contact belongs to.

Prerequisites prerequisites

Refer to the sections below for any prerequisites that you need to set up in Experience Platform and HubSpot and for information that you must gather before working with the HubSpot destination.

Experience Platform prerequisites prerequisites-in-experience-platform

Before activating data to the HubSpot destination, you must have a schema, a dataset, and audiences created in Experience Platform.

Refer to Experience Platform documentation for Audience Membership Details schema field group if you need guidance on audience statuses.

Prerequisites for the HubSpot destination prerequisites-destination

Note the following prerequisites in order to export data from Platform to your HubSpot account:

You must have a HubSpot account prerequisites-account

In order to export data from Platform to your Hubspot account you need to have a HubSpot account. If you do not have one already, visit the Set up your HubSpot account page and follow the guidance to register and create your account.

Gather the HubSpot private app access token gather-credentials

You need your HubSpot Access token to allow the HubSpot destination to make API calls through your HubSpot private app within your HubSpot account. The Access token serves as the Bearer token when you authenticate the destination.

If you do not have a private app, follow the documentation to Create a private app in HubSpot.

IMPORTANT
The private app should be assigned the scopes below:
crm.objects.contacts.write, crm.objects.contacts.read
crm.schemas.contacts.write, crm.schemas.contacts.read
Credential
Description
Example
Bearer token
The Access token of your HubSpot private app.
To obtain your HubSpot Access token follow the HubSpot documentation to make API calls with your app’s access token.
pat-na1-11223344-abcde-12345-9876-1234a1b23456

Guardrails guardrails

HubSpot private apps are subject to Rate Limits. The number of calls your private app can make is based on your HubSpot account subscription and whether you’ve purchased the API add-on. Additionally also refer to the Other Limits.

Supported identities supported-identities

HubSpot supports update of identities described in the table below. Learn more about identities.

Target Identity
Example
Description
Considerations
email
test@test.com
Email address of the contact.
Mandatory

Supported audiences supported-audiences

This section describes all the audiences that you can export to this destination.

This destination supports the activation of all audiences generated through the Experience Platform Segmentation Service.

This destination also supports the activation of the audiences described in the table below.

Audience type
Description
Custom uploads
Audiences imported into Experience Platform from CSV files.

Export type and frequency export-type-frequency

Refer to the table below for information about the destination export type and frequency.

Item
Type
Notes
Export type
Profile-based
  • You are exporting all members of an audience, together with the desired schema fields (for example: email address, phone number, last name), according to your field mapping.
  • Additionally, a new property is created in HubSpot using the audience name and its value is with the corresponding audience status from Platform, for each of the selected audiences.
Export frequency
Streaming
  • Streaming destinations are “always on” API-based connections. As soon as a profile is updated in Experience Platform based on audience evaluation, the connector sends the update downstream to the destination platform. Read more about streaming destinations.

Connect to the destination connect

IMPORTANT
To connect to the destination, you need the View Destinations and Manage Destinations access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.

To connect to this destination, follow the steps described in the destination configuration tutorial. In the configure destination workflow, fill in the fields listed in the two sections below.

Within Destinations > Catalog search for HubSpot. Alternatively you can locate it under the CRM category.

Authenticate to destination authenticate

Fill in the required fields below. Refer to the Gather the HubSpot private app access token section for any guidance.

  • Bearer token: The access token for your HubSpot private app.

To authenticate to the destination, select Connect to destination.
Platform UI screenshot showing how to authenticate.

If the details provided are valid, the UI displays a Connected status with a green check mark. You can then proceed to the next step.

Fill in destination details destination-details

To configure details for the destination, fill in the required and optional fields below. An asterisk next to a field in the UI indicates that the field is required.
Platform UI screenshot showing the destination details.

  • Name: A name by which you will recognize this destination in the future.
  • Description: A description that will help you identify this destination in the future.

Enable alerts enable-alerts

You can enable alerts to receive notifications on the status of the dataflow to your destination. Select an alert from the list to subscribe to receive notifications on the status of your dataflow. For more information on alerts, see the guide on subscribing to destinations alerts using the UI.

When you are finished providing details for your destination connection, select Next.

Activate audiences to this destination activate

IMPORTANT
To activate data, you need the View Destinations, Activate Destinations, View Profiles, and View Segments access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.

Read Activate profiles and audiences to streaming audience export destinations for instructions on activating audiences to this destination.

Map attributes and identities map

To correctly send your audience data from Adobe Experience Platform to the HubSpot destination, you must go through the field mapping step. Mapping consists of creating a link between your Experience Data Model (XDM) schema fields in your Platform account and their corresponding equivalents from the target destination.

To correctly map your XDM fields to the HubSpot destination fields, follow the steps below:

Mapping the Email identity

The Email identity is a mandatory mapping for this destination. Follow the steps below to map it:

  1. In the Mapping step, select Add new mapping. You can now see a new mapping row on the screen.
    Platform UI screenshot with add new mapping button highlighted.
  2. In the Select source field window, choose the Select identity namespace and select an identity.
    Platform UI screenshot selecting email as a source attribute to map as identity.
  3. In the Select target field window, choose the Select attributes and select email.
    Platform UI screenshot selecting email as a target attribute to map as identity.
Source Field
Target Field
Mandatory
IdentityMap: Email
Identity: email
Yes

An example with the identity mapping is shown below:
Platform UI screenshot example with email identity mapping.

Mapping optional attributes

To add any other attributes you want to update between your XDM profile schema and your HubSpot account repeat the steps below:

  1. In the Mapping step, select Add new mapping. You can now see a new mapping row on the screen.
    Platform UI screenshot with add new mapping button highlighted.
  2. In the Select source field window, choose the Select attributes category and select the XDM attribute.
    Platform UI screenshot selecting First Name as a source attribute.
  3. In the Select target field window, choose Select attributes category and select from the list of attributes which are automatically populated from your HubSpot account. The destination uses the HubSpot Properties API to retrieve this information. Both HubSpot default properties and any custom properties are retrieved for selection as target fields.
    Platform UI screenshot selecting First Name as a target attribute.

A few available mappings between your XDM profile schema and Hubspot are shown below:

Source Field
Target Field
xdm: person.name.firstName
Attribute: firstname
xdm: person.name.lastName
Attribute: lastname
xdm: workAddress.street1
Attribute: address
xdm: workAddress.city
Attribute: city
xdm: workAddress.country
Attribute: country

An example using these attributes mappings is shown below:
Platform UI screenshot example with attribute mappings.

When you are finished providing the mappings for your destination connection, select Next.

Validate data export exported-data

To validate that you have correctly set up the destination, follow the steps below:

  1. Log in to the HubSpot website, then navigate to the Contacts page to check the audience statuses. This list can be configured to display columns for the custom properties created with the audience name with their value being the audience statuses.
    HubSpot UI screenshot showing the Contacts page with column headers showing the audience name and cells audience statuses

  2. You can alternatively drill down into an individual Person page and navigate to the properties displaying the audience name and audience statuses.
    HubSpot UI screenshot showing the Contact page with custom properties displaying the audience name and audience statuses.

Data usage and governance data-usage-governance

All Adobe Experience Platform destinations are compliant with data usage policies when handling your data. For detailed information on how Adobe Experience Platform enforces data governance, see the Data Governance overview.

Additional resources additional-resources

Additional useful information from the HubSpot documentation is below:

Changelog

This section captures the functionality and significant documentation updates made to this destination connector.

View changelog
table 0-row-3 1-row-3 layout-auto
Release month Update type Description
September 2023 Initial release Initial destination release and documentation publish.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6