Heap
Heap (now part of Contentsquare) is a product
analytics platform with auto-capture and retroactive event definitions.
This destination loads the Heap snippet from Heap's CDN and forwards
walkerOS events through heap.track(name, properties), plus identity,
user properties, persistent event properties, and runtime consent.
Heap is a web destination in the walkerOS flow:
Installation
- Integrated
- Bundled
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
| Property | Type | Description | More |
|---|---|---|---|
appId | string | Heap App ID. Find it in your Heap project under Settings > App ID. | |
disableTextCapture | boolean | Disable Heap auto text capture. Default: true. | |
disablePageviewAutocapture | boolean | Disable Heap automatic pageview tracking. Default: true (walkerOS sources handle pageviews). | |
disableSessionReplay | boolean | Disable Heap session replay. | |
secureCookie | boolean | SSL-only cookies. | |
ingestServer | string | Custom server endpoint for proxying Heap data. | |
identify | any | Destination-level identity mapping. Resolves to a string for heap.identify(). Example: { "key": "user.id" }. | |
userProperties | any | Destination-level user properties mapping. Resolves to object for heap.addUserProperties(). Example: { "map": { "plan": "data.plan" } }. |
Mapping
Per-event rules under config.mapping. For the standard rule fields (consent, condition, data, batch, name, policy) see mapping.
| Property | Type | Description | More |
|---|---|---|---|
identify | any | Per-event identity. Resolves to a string for heap.identify(). Example: { "key": "data.email" }. | |
reset | any | Reset Heap identity on this event. Set to true to call heap.resetIdentity(). | |
userProperties | any | Per-event user properties. Resolves to object for heap.addUserProperties(). | |
eventProperties | any | Per-event persistent event properties. Resolves to object for heap.addEventProperties() (persisted across page loads). | |
clearEventProperties | any | Clear all persistent event properties. Set to true to call heap.clearEventProperties(). |
Examples
Consent granted
A walker consent grant for analytics calls heap.startTracking to resume event capture.
Consent revoked
A walker consent revoke for analytics calls heap.stopTracking to pause event capture.
Default track
A walker event becomes a Heap track call with the event name and empty properties.
Destination identify
Destination-level identify calls heap.identify with the user id before firing the default track.
Renamed purchase
An order complete is renamed to purchase and mapped to Heap track properties such as order_id, total, and currency.
User properties on event
An order fires Heap addUserProperties with last-order fields and then tracks the event.
Global event properties
A page view sets persistent Heap event properties so all subsequent events include the page category.
User login identify
A user login identifies the Heap user by email and adds user properties while skipping the track.
User logout reset
A user logout calls heap.resetIdentity to clear the identified user from the Heap client.
Consent
The destination wires walkerOS config.consent to Heap's runtime consent
API. heap.startTracking() fires when all required consent keys are
granted; heap.stopTracking() fires otherwise.