Skip to main content

HubSpot tracking code and custom events

Using the HubSpot tracking code to centralize reader engagement data

Updated this week

Notes:

  • The default HubSpot tracking code is available with all Turtl plans and with all HubSpot subscriptions.

  • Custom events setup in Turtl is available with the Grow AI and Scale AI plan. Please contact support if you want to upgrade your plan.

  • Please check HubSpot’s Create Custom Events article for information on which HubSpot subscriptions support custom events.

Adding the default HubSpot tracking code to Turtl allows you to track Turtl Doc visits, but you can also send other interesting moments through a custom events setup to support various processes.

How to enable the tracking code

To enable the tracking code, please follow the steps:

1. Accessing the Integrations Hub

To access the Integrations Hub, click on "Integrate” in the left hand menu.

The Integrations screen will show all available integrations in a grid layout.

2. Enable the tracking code

Click on HubSpot, and under the Settings tab, click on "Reader Intent Data" to expand the section.

Toggle on the setting to enable the tracking code for all Docs.
​

How do these default events appear in HubSpot?

You will get a confirmation when the extension is applied to your tenant from the support team at Turtl. You can then set up a test Doc, flip through it, and then check if the views for that Doc came through to HubSpot. You can see these events in two key places:

1. On the Activity section of a Contact record

Navigate to "CRM" -> "Contacts". Events appear under the "Activities" tab under the Contact record as "Page views".

2. Within reports

Navigate to "Reporting & Data"-> "Reports"-> "Traffic", then click on the "Pages" tab to view page views for specific Turtl Docs.

Note: At the time of writing (April 2024), the traffic page was only available with Marketing Hub Professional and above pricing plans.

See also: Troubleshoot the HubSpot tracking code

How to send custom reader engagement events to HubSpot?

Within Integrations, click HubSpot, then go to the Settings tab and open the Reader Intent Data section.

Under Custom events, if you already have custom event snippets set up, you’ll see the following notice:

If you do not have any existing custom events snippets set up previously, you can now automatically enable custom events yourself by expanding each heading and toggling on the options you want.

Once selected, you’ll see the following confirmation:
​

You will then automatically see each selected custom event in your HubSpot account.

Custom events list with properties

Below is a description of each of the custom events used:

Notes:

  • Properties in bold can be used for all events.

  • Other properties are event-specific.

  • Words between braces are data types/field types, eg. Page URL (string) → Page URL value is a string.

  • Please contact our support team to share your ideas if you want to track something else.

Event name

Custom properties

Notes

Chapter page turn

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Title page turn

Page turn

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Content page turn

Read time 30 seconds

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Read time 1 minute

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Read time 2 minutes

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Read time 3 minutes

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Read time 4 minutes

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Read time 5 minutes

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Read time 8 minutes

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Read time 10 minutes

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Enter chapter

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Enter Content page(s)

Leave chapter

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Leave Content page(s)

Logo click

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Contents menu click

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Download the PDF version

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

PDF download button in the Contents menu

Open fullscreen

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Link click

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Destination (string)

Lead capture form submission

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Personalization form submission

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

Poll submission

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Question (string)

  • Response (string)

Share button click - Email

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Share button location (string)

Share button location custom property specifies the location where the share button was clicked:

  • Toolbar

  • Immerse level widget

  • Back cover

Share button click - X

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Share button location (string)

Share button location custom property specifies the location where the share button was clicked:

  • Toolbar

  • Immerse level widget

  • Back cover

Share button click - Facebook

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Share button location (string)

Share button location custom property specifies the location where the share button was clicked:

  • Toolbar

  • Immerse level widget

  • Back cover

Share button click - Linkedin

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Share button location (string)

Share button location custom property specifies the location where the share button was clicked:

  • Toolbar

  • Immerse level widget

  • Back cover

Share button click - Xing

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Share button location (string)

Share button location custom property specifies the location where the share button was clicked:

  • Toolbar

  • Immerse level widget

  • Back cover

View chart

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Source (string)

  • Open chart in zoom mode

View image

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Source (string)

  • Open image in zoom mode

View map

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Source (string)

  • Open the map in zoom mode

View PDF

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Source (string)

  • Open PDF in zoom mode

Watch video

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Source (string)

Listen to audio

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Source (string)

View Matterport tour

  • Doc name (string)

  • Doc URL (string)

  • Page URL (string)

  • Workspace (string)

  • Page title (string)

  • Label (string)

  • Source (string)

How do these custom events appear in HubSpot?

You can then set up a test Doc and trigger the custom events you had set up.

Custom events will appear in HubSpot in the same way that default events do.
​
In addition, custom events can be seen in the Custom Events Report. To access that, navigate to "Reporting & Data" -> "Custom events", then click the "Analyze tab".

See the HubSpot article Analyze custom events for more information.

Related Articles
Google Analytics 4 tracking code and custom events
Oracle Eloqua tracking code and custom events
Account engagement (Pardot) tracking code
Marketing Cloud tracking code
Marketo tracking code and custom events
Did this answer your question?