Step-by-step guide on sending your event data from RudderStack to Microsoft Clarity.
3 minute read
Microsoft Clarity is a heatmaps and session recording tool. It helps you better understand how users are interacting with your website through session replays and heatmaps.
Once you have confirmed that the source platform supports sending events to Microsoft Clarity, follow these steps:
From your RudderStack dashboard, add a source. Then, from the list of destinations, select Microsoft Clarity.
Assign a name to the destination and click Continue.
Connection settings
To successfully configure Microsoft Clarity as a destination, you will need to configure the following settings:
Project ID: Enter your Microsoft Clarity project ID. For more information on obtaining your Clarity project ID, refer to the FAQ section below.
Microsoft Clarity Cookie Consent: Enable this setting to allow RudderStack to call the Microsoft Clarity API to track the users using a cookie.
Client-side Events Filtering: This setting lets you specify which events should be blocked or allowed to flow through to Microsoft Clarity. For more information on this setting, refer to the Client-side Events Filtering guide.
Use device mode to send events: As this is a web device mode-only destination, this setting is enabled by default and cannot be disabled.
By default, Clarity uses cookies to track your users and gather the session data. You can configure your Clarity project to require cookie consent, that is, Clarity will not place a cookie until a user provides consent.
In this case, to track the user sessions via the cookie, make sure you enable the Microsoft Clarity Cookie Consent setting in the RudderStack dashboard. This setting indicates that RudderStack can call the Clarity API to track the users via a cookie once a user provides consent.
If the Cookies setting is enabled in the Clarity project settings, then you need not enable the Microsoft Clarity Cookie Consent dashboard setting.
Supported mappings
RudderStack maps the following identify attributes to the corresponding Microsoft Clarity properties:
RudderStack property
Microsoft Clarity property
userId Required
customuserid
context.sessionId
customsessionid
context.traits.customPageId
custompageid
FAQ
Where can I find the Microsoft Clarity project ID?
To get your Microsoft Clarity project ID, follow these steps:
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.