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 grant start tracking
consent revoke stop tracking
default event forwarding
destination level identify
destination level include
event with user properties
global event properties
user login identify
user logout reset
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.