Skip to main content

Hotjar

Web Source code Package Beta

Hotjar provides session recordings, heatmaps, and on-page feedback for web products. This destination forwards walkerOS events to Hotjar via the official @hotjar/browser SDK, translating events into Hotjar.event(...) calls and handling identity and SPA state changes.

Where this fits

Hotjar is a web destination in the walkerOS flow:

Installation

Loading...
Loading...

Configuration

This destination uses the standard destination config wrapper (consent, data, env, id, ...). For the shared fields see destination configuration. Package-specific fields live under config.settings and are listed below.

Settings

PropertyTypeDescriptionMore
siteId*integerYour Hotjar site ID (e.g. 1234567). Find it in your Hotjar dashboard under Settings.
hotjarVersionintegerHotjar snippet version. Defaults to 6 (current). Override only if Hotjar releases a new version.
debugbooleanEnable Hotjar debug mode for development troubleshooting.
noncestringCSP nonce for the injected Hotjar script tag. Required when using strict Content-Security-Policy.
identifyanywalkerOS mapping value resolving to { userId, ...attributes } for Hotjar.identify(). userId is extracted as the first argument; remaining keys become user attributes.
* Required fields

Mapping

Per-event rules under config.mapping. For the standard rule fields (consent, condition, data, batch, name, policy) see mapping.

PropertyTypeDescriptionMore
identifyanyPer-event identity mapping. Resolves to { userId, ...attributes } -> Hotjar.identify(userId, attributes).
stateChangeanySPA route change notification. Resolves to a relative path string -> Hotjar.stateChange(path). Used for accurate heatmaps on virtual page views.

Examples

combined features

Event
Mapping
Out

default event forwarding

Event
Out

destination level identify

Event
Out

page view skip

Event
Mapping
Out

page view state change

Event
Mapping
Out

renamed event

Event
Mapping
Out

user login identify

Event
Mapping
Out

wildcard ignored

Event
Mapping
Out

Hotjar has no runtime consent API. Consent is gated at the walkerOS level via config.consent:

Loading...

Unconsented events are blocked by the collector before reaching the destination.

💡 Need implementation support?
elbwalker offers hands-on support: setup review, measurement planning, destination mapping, and live troubleshooting. Book a 2-hour session (€399)