---
title: Microsoft Clarity
description: Session replay and behavior analytics with a prebuilt helper that
keeps Clarity consent synchronized with c15t measurement state.
group: integrations
lastModified: 2026-05-10
icon: microsoft-clarity
---
Microsoft Clarity gives you session recordings, heatmaps, and behavioral insights. The `clarity()` helper sets up Clarity's queue stub, loads the vendor bundle, and keeps Clarity's consent state in sync as c15t measurement consent changes.
## Integrate with c15t
**React**
```tsx
import { type ReactNode } from 'react';
import { ConsentManagerProvider } from '@c15t/react';
import { clarity } from '@c15t/scripts/microsoft-clarity';
const scripts = [
clarity({
id: 'abcdef1234',
}),
];
export function ConsentProvider({ children }: { children: ReactNode }) {
return (
{children}
);
}
```
**Next.js**
```tsx
'use client';
import { type ReactNode } from 'react';
import { ConsentManagerProvider } from '@c15t/nextjs';
import { clarity } from '@c15t/scripts/microsoft-clarity';
const scripts = [
clarity({
id: 'abcdef1234',
}),
];
export function ConsentProvider({ children }: { children: ReactNode }) {
return (
{children}
);
}
```
**JavaScript**
```ts
import { getOrCreateConsentRuntime } from 'c15t';
import { clarity } from '@c15t/scripts/microsoft-clarity';
getOrCreateConsentRuntime({
mode: 'hosted',
backendURL: 'https://your-instance.c15t.dev',
scripts: [
clarity({
id: 'abcdef1234',
}),
],
});
```
## How c15t loads it
* **Category:** `measurement` (Analytics)
* **Loads when:** measurement consent is granted
* **On revocation:** stays loaded (`persistAfterConsentRevoked: true`) and receives `clarity('consent', false)` so Clarity transitions into denied mode without tearing down the script.
## Configure the integration
You can queue an initial Clarity consent value before the script loads.
```ts
import { clarity } from '@c15t/scripts/microsoft-clarity';
clarity({
id: 'abcdef1234',
defaultConsent: false,
});
```
Use an object when you need to map granular consent categories into Clarity's boot-time consent payload:
```ts
clarity({
id: 'abcdef1234',
defaultConsent: {
marketing: false,
analytics: true,
},
});
```
c15t queues that exact `defaultConsent` object during boot. Later consent changes are mapped to simple `true` or `false` values when c15t updates Clarity.
## Tracking events in your app
c15t gates the Clarity script from loading until `measurement` consent is granted. Your application code that calls Clarity's runtime API (`window.clarity(...)`) is **not** automatically gated - `window.clarity` does not exist until the script is loaded, so unguarded calls before consent throw.
Guard event calls by checking consent state. From React:
```tsx
import { useCallback } from 'react';
import { useConsentManager } from '@c15t/react';
function SignupExample() {
const { has } = useConsentManager();
const trackSignup = useCallback(() => {
if (has('measurement')) {
window.clarity?.('event', 'signup');
}
}, [has]);
// Call trackSignup() from an event handler after signup succeeds.
}
```
From plain JavaScript:
```ts
import { getOrCreateConsentRuntime } from 'c15t';
const { consentStore } = getOrCreateConsentRuntime();
if (consentStore.getState().has('measurement')) {
window.clarity?.('event', 'signup');
}
```
## Types
### ClarityOptions
|Property|Type|Description|Default|Required|
|:--|:--|:--|:--|:--:|
|id|string|Your Microsoft Clarity project ID.|-|✅ Required|
|defaultConsent|ClarityConsentValue \|undefined|Optional initial consent value queued before the script loads.
Object-shaped advanced consent vectors are supported only for this initial
boot-time value. Later c15t consent changes are mapped to simple booleans.|-|Optional|
|scriptUrl|string \|undefined|Clarity loader URL.|-|Optional|
### Script
|Property|Type|Description|Default|Required|
|:--|:--|:--|:--|:--:|
|id|string|Unique identifier for the script|-|✅ Required|
|src|string \|undefined|URL of the script to load|-|Optional|
|textContent|string \|undefined|Inline JavaScript code to execute|-|Optional|
|category|HasCondition\|Consent category or condition required to load this script|-|✅ Required|
|callbackOnly|boolean \|undefined|Whether this is a callback-only script that doesn't need to load an external resource.
When true, no script tag will be added to the DOM, only callbacks will be executed.
This is useful for:
- Managing consent for libraries already loaded on the page
- Enabling/disabling tracking features based on consent changes
- Running custom code when consent status changes without loading external scripts
Example use cases:
- Enabling/disabling Posthog tracking
- Configuring Google Analytics consent mode
- Managing cookie consent for embedded content|false|Optional|
|persistAfterConsentRevoked|boolean \|undefined|Whether the script should persist after consent is revoked.|false|Optional|
|alwaysLoad|boolean \|undefined|Whether the script should always load regardless of consent state.
This is useful for scripts like Google Tag Manager or PostHog that manage
their own consent state internally. The script will load immediately and
never be unloaded based on consent changes.
Note: When using this option, you are responsible for ensuring the script
itself respects user consent preferences through its own consent management.|false|Optional|
|fetchPriority|"high" \|"low" \|"auto" \|undefined|Priority hint for browser resource loading|-|Optional|
|attributes|Record\ \|undefined|Additional attributes to add to the script element|-|Optional|
|async|boolean \|undefined|Whether to use async loading|-|Optional|
|defer|boolean \|undefined|Whether to defer script loading|-|Optional|
|nonce|string \|undefined|Content Security Policy nonce|-|Optional|
|anonymizeId|boolean \|undefined|Whether to use an anonymized ID for the script element, this helps ensure the script is not blocked by ad blockers|true|Optional|
|target|"head" \|"body" \|undefined|Where to inject the script element in the DOM.
- \`'head'\`: Scripts are appended to \`\\` (default)
- \`'body'\`: Scripts are appended to \`\\`
Use \`'body'\` for scripts that:
- Need to manipulate DOM elements that don't exist until body loads
- Should load after page content for performance reasons
- Are required by third-party services to be in the body
Use \`'head'\` (default) for scripts that:
- Need to track early page events (analytics)
- Should be available before page render
- Most tracking/analytics scripts|'head'|Optional|
|onBeforeLoad|((info: ScriptCallbackInfo) => void) \|undefined|Callback executed before the script is loaded|-|Optional|
|onLoad|((info: ScriptCallbackInfo) => void) \|undefined|Callback executed when the script loads successfully|-|Optional|
|onError|((info: ScriptCallbackInfo) => void) \|undefined|Callback executed if the script fails to load|-|Optional|
|onConsentChange|((info: ScriptCallbackInfo) => void) \|undefined|Callback executed whenever the consent store is changed.
This callback only applies to scripts already loaded.|-|Optional|
|vendorId|string \|number \|undefined|IAB TCF vendor ID - links script to a registered vendor.
When in IAB mode, the script will only load if this vendor has consent.
Takes precedence over \`category\` when in IAB mode.
Use custom vendor IDs (string or number) to gate non-IAB vendors too.|-|Optional|
|iabPurposes|number\[] \|undefined|IAB TCF purpose IDs this script requires consent for.
When in IAB mode and no vendorId is set, the script will only load
if ALL specified purposes have consent.|-|Optional|
|iabLegIntPurposes|number\[] \|undefined|IAB TCF legitimate interest purpose IDs.
These purposes can operate under legitimate interest instead of consent.
The script loads if all iabPurposes have consent OR all iabLegIntPurposes
have legitimate interest established.|-|Optional|
|iabSpecialFeatures|number\[] \|undefined|IAB TCF special feature IDs this script requires.
Special features require explicit opt-in:
- 1: Use precise geolocation data
- 2: Actively scan device characteristics for identification|-|Optional|