Hotjar: setup and help

Follow the steps in Quick start.

Open Configure from Module Manager. Tracking starts disabled. Create your site in Hotjar before entering its Site ID.

The module checks consent before sending. It supports Cookies Revolution, Cookie Banner, Cookiebot, OneTrust and TCF. Configure the relevant category and service decisions in your consent tool and test them. Without an explicit decision, tracking stays held. A supported CMP detected by the module still applies if you turn off the module's consent switch.

Hotjar events

Every switch below defaults to Yes. Turn off the events you do not want to send.

Hotjar receives event names through hj('event', 'event_name'). It does not receive the product IDs, cart totals, search terms or order details as event properties from this integration.

Contact and product engagement

Track phone-link clicks, Track actual chat starts, Track successful contact forms and Track product engagement default to No. Enable only the signals you can verify. A form event requires a server-confirmed success receipt. A chat event requires a supported actual-start notification.

Use Product engagement thresholds for JSON thresholds and selectors. Defaults are 3 gallery interactions, 1 variant change, 1 detail interaction, or 45 seconds of dwell time. The option throttle defaults to 1500 ms. Threshold bounds are 1 to 20 interactions, 5 to 600 seconds, and 250 to 60000 ms for the throttle. Keep high_intent_product_engagement as the event name. By default, the tracker limits this event to once per product/session when tracking storage is allowed.

Track custom events defaults to No. Custom event rules starts empty. Add at least one valid rule before enabling the switch.

Use distinct names of up to 250 supported characters: letters, numbers, underscores, spaces, periods, colons, vertical bars, slashes or hyphens. You can configure up to 50 distinct custom names. Built-in commerce and contact names are reserved.

[
  {"event":"GalleryBrowse","trigger":"click","selector":".product-cover img"},
  {"event":"CheckoutPathViewed","trigger":"url","contains":["/checkout"]},
  {"event":"ProductPageViewed","trigger":"controller","controllers":["product"]},
  {"event":"SizeGuideOpened","trigger":"event","dom_event":"mprhjar:size-guide"}
]

Use selector for clicks, contains for URL fragments, controllers for controller rules, and dom_event for browser events. A controller rule with modules requires both conditions to match. It is not a module fallback. A DOM-event rule without a name listens to mprhjar:custom. once defaults to false for clicks and true for URL, controller and DOM-event rules.

Dispatch the configured event from your theme:

document.dispatchEvent(new CustomEvent('mprhjar:size-guide'));

The rule sends only SizeGuideOpened. params, labels, form values and DOM-event detail do not become Hotjar event properties.

Open your storefront outside an excluded staff browser. With analytics consent granted, check the request to https://static.hotjar.com/c/hotjar-SITE_ID.js?sv=6. Open a product and category, search, add a product successfully, register an account and place a test order. Check the enabled event names in browser tooling and your Hotjar account.

Test refusal and withdrawal. Check that another module or theme has not loaded its own Hotjar script. The integration checks destination ownership, staff state, consent and page safety before sending. Heatmaps, recordings and feedback reports stay in Hotjar.

If no script loads, check the Site ID, Enable Hotjar, readiness rows, analytics/service consent, local assets and blocked requests. Test in a customer browser. A missing consent decision holds tracking even if no MPR banner is installed.

If a cart event is missing, verify the confirmed cart-success signal. A cart-button click alone does not emit this event. Adapt your custom rules after theme selector changes.

If custom rules fail to save, check JSON, reserved names, name limits and trigger requirements. If a purchase does not repeat on a confirmation reload, its once-per-order claim may already be consumed.

This module sends browser event names. It has no Hotjar server token, retry queue or sending cron worker.

Set Enable Hotjar to No and save to pause tracking while keeping settings. Uninstall through Module Manager to remove its menu and module configuration. Manage previously collected reports in Hotjar.

Use the setting names above when a reference screenshot differs from your installed version.