Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideProduct feedbackGitHubNuGetDev CommunitySubmit a ticketLog In

Integrate Hotjar

Describes how to tag Hotjar recordings with Optimizely experiment and campaign data, create specific Hotjar Heatmaps for your experiment and campaign, and integrate Hotjar with Optimizely Web Experimentation for Hotjar Heatmaps & Recordings

What does this integration let you do? 

This integration lets you tag Hotjar Heatmaps and Recordings with Optimizely experiment and campaign information.

  • Hotjar Heatmaps – You may want to see if changes in a variation lead to visitors scrolling further down or clicking on re-designed elements. With Optimizely experiment and campaign information in Hotjar Heatmaps, you can drill down per variation and get a better understanding of your visitors' scrolls, clicks and moves. 
  • Hotjar Recordings – You may want to see if your visitor's behavior has changed because of a variation. With Optimizely experiment information in your Hotjar recordings, you can filter recordings per variation.

📘

Note

The Hotjar integration is owned by Hotjar. The integration currently only supports Hotjar Recordings and Feedback. Development on the integration to enable Heatmaps is ongoing/on the roadmap. If you have any questions regarding the Hotjar integration, contact Hotjar's Support Team.

Set up the integration with Hotjar Heatmaps

Pre-requisite 1: Add and enable the Hotjar Heatmaps and Recordings integration to your account. You can get the extension here.

Pre-requisite 2:  Enable the force variation parameter by going to Settings in Optimizely and ensuring Disable force variation parameter is unchecked. 

  1. Get your experiment's variation IDs by going to the experiment in the Optimizely UI, clicking onto the experiment you want to integrate, and clicking on API Names. The variation IDs are in the Variations section. 
  2. Note the IDs because you need them later.
  3. Go to the experiment for the Hotjar integration and click the Integrations tab. You should see the following: 

If you do not see this, the integration is not enabled in your account. See Pre-requisite 1 to enable it.  

  1. Make sure the Heatmaps field is set to ON and enter an Event prefix. This can be any string, and you should use a short name of your experiment name. This does not appear in Hotjar and is only used by Optimizely Web Experimentation to trigger the right heatmap matching your experiment. Avoid the use of special characters. Example of the acceptable prefix: homepageRedesign.
  2. Go to Hotjar and create one heatmap per variation.
  3. Go to Session Targeting and select Start capturing sessions on specific pages or when a custom event fires.
  4. Select Event for Enter Page URL.
  5. Enter the prefix you picked before with an underscore ( _ ) and the variation ID for the Event value. Example of correct prefix: homepageRedesign\_8575810288.
  6. Go to Custom Screenshot URL and enter the URL of a page where the experiment is running and append to this URL Optimizely's force variation parameters. The final URL should look something like this: www.example.com/my-page/?optimizely\_x=\[variationId\]
  7. Generate the heatmap and start the Optimizely experiment. 

📘

Note

If you are running a personalization campaign with a holdback that is not set to 0%, create a Hotjar Heatmap for the holdback. When creating this heatmap, input the Event in Hotjar as follows: your prefix with an underscore ( _ ) and holdback. For example if the prefix is homepageRedesign, then the Event is homepageRedesign_holdback. Leave Custom Screenshot URL in Hotjar empty.

Set up integration with Hotjar Recordings

Pre-requisite: The Hotjar Heatmaps and Recordings integration needs to be added to your account and enabled. You can get the extension on GitHub.

This integration adds a tag to Hotjar Recordings labeled with the Optimizely experiment, audience, and variation information.

To enable this integration, go to the experiment for the recording tag, and set the Recordings field to ON. Check the Tracked box and click Save

This experiment now tags all visitors with Optimizely experiment and campaign information. This tag displays in your Hotjar recordings.