Microsoft Clarity
Microsoft Clarity provides session replays,
heatmaps and behavioural insights for web products, free and without sampling
caps. This destination forwards walkerOS events to Clarity via the official
@microsoft/clarity SDK,
translating events into Clarity.event(...) calls, resolving custom tags,
identities, session priority, and consent state.
Clarity is a web destination in the walkerOS flow:
Loads the Clarity SDK, forwards every walkerOS event, and lets you layer on custom tags, identities, and consent translation.
Installation
Setup
- Integrated
- Bundled
Configuration reference
| Property | Type | Description | More |
|---|---|---|---|
apiKey | string | Your Microsoft Clarity project ID (e.g. "3t0wlogvdz"). Find it in your Clarity dashboard under Settings → Setup. | |
consent | Record<string, string> | Translation table from walkerOS consent keys to Clarity ConsentV2 categories. Example: { "analytics": "analytics_Storage", "marketing": "ad_Storage" }. Required to get meaningful consent behavior — Clarity expects its own category names. | |
identify | any | walkerOS mapping value resolving to positional arguments for Clarity.identify(). Keys: customId (required), customSessionId?, customPageId?, friendlyName?. |
Mapping data.examples
The code data.examples are interactive. You can edit the code to generate your individual event mapping.
Default event forwarding
Every walkerOS event becomes Clarity.event(name) without any mapping.
Custom tags via set
Resolve explicit key/value pairs into Clarity.setTag(key, value) calls.
Flatten sections with include
Forward entire walkerOS event sections as prefixed Clarity tags.
Identify
Resolve a mapping value into positional Clarity.identify(...) arguments.
Session priority upgrade
Flag important sessions so Clarity retains them beyond sampling.
Consent translation
Clarity expects its own category names (analytics_Storage, ad_Storage).
walkerOS uses arbitrary consent keys, so translation is explicit: configure
settings.consent once and the destination maps every walker consent event
into Clarity.consentV2({ ... }). When all mapped keys are revoked, the
destination additionally calls Clarity.consent(false) (the legacy v1 API
that erases cookies and ends the session).