Skip to content

chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LauraBeatris merged 5 commits into from
Jun 23, 2026
Merged

chore(shared,ui): Add telemetry event for flow steps #8951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d65bd65
Add telemetry event
LauraBeatris Jun 22, 2026
242878f
Emit event on activate step
LauraBeatris Jun 22, 2026
ab1cac9
Emit on verify-domain step
LauraBeatris Jun 22, 2026
f1c2675
Emit with organization ID as metadata
LauraBeatris Jun 22, 2026
56719d3
Add changeset
LauraBeatris Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/gold-ends-throw.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow
40 changes: 40 additions & 0 deletions packages/shared/src/telemetry/events/flow-step.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
/** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
flow: string;
/** The step/part that mounted, e.g. `verify-domain` */
step: string;
/** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
* Fires an event from a part of a multi-step flow.
*
* @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
* @param step - The step/part that mounted.
* @param metadata - Flow-specific metadata sent under `payload.metadata`.
* @param eventSamplingRate - Override the default full-capture sampling rate.
* @example
* telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
*/
export function eventFlowStepMounted(
flow: string,
step: string,
metadata: TelemetryEventRaw['payload'] = {},
eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
return {
event: EVENT_FLOW_STEP_MOUNTED,
eventSamplingRate,
payload: {
flow,
step,
metadata,
},
};
}
1 change: 1 addition & 0 deletions packages/shared/src/telemetry/events/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';
13 changes: 13 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
onExit,
} = useConfigureSSO();
const card = useCardState();
const clerk = useClerk();
const { organization } = useOrganization();

// The activate step is only reachable with a configured connection, so the
// domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

try {
await setConnectionActive(enterpriseConnection.id, true);
clerk.telemetry?.record(
eventFlowStepMounted('configureSSO', 'activate', {
timestamp: new Date().toISOString(),
connectionStatus: 'active',
connectionId: enterpriseConnection.id,
organizationId: organization?.id ?? null,
}),
);
onExit?.();
} catch (err) {
handleError(err as Error, [], card.setError);
Expand Down
26 changes: 24 additions & 2 deletions packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
const {
enterpriseConnection,
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
const card = useCardState();
const clerk = useClerk();
const { organization } = useOrganization();
const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

const hasRecordedTelemetryEvent = useRef(false);
useEffect(() => {
if (hasRecordedTelemetryEvent.current) {
return;
}

hasRecordedTelemetryEvent.current = true;
clerk.telemetry?.record(
eventFlowStepMounted('configureSSO', 'verify-domain', {
timestamp: new Date().toISOString(),
connectionStatus: organizationEnterpriseConnection.status,
connectionId: enterpriseConnection?.id ?? null,
organizationId: organization?.id ?? null,
}),
);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);

const handleCreateDomain = async (domain: string) => {
card.setError(undefined);

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
chore(shared,ui): Add telemetry event for flow steps by LauraBeatris · Pull Request #8951 · clerk/javascript · GitHub
Skip to content
chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LauraBeatris
merged 5 commits into

from

Jun 23, 2026
 Merged


chore(shared,ui): Add telemetry event for flow steps
#8951
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d65bd65

Add telemetry event


LauraBeatris Jun 22, 2026
242878f

Emit event on activate step


LauraBeatris Jun 22, 2026
ab1cac9

Emit on verify-domain step


LauraBeatris Jun 22, 2026
f1c2675

Emit with organization ID as metadata


LauraBeatris Jun 22, 2026
56719d3

Add changeset


LauraBeatris Jun 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/gold-ends-throw.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow

40 changes: 40 additions & 0 deletions
packages/shared/src/telemetry/events/flow-step.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
 /** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
 flow: string;
 /** The step/part that mounted, e.g. `verify-domain` */
 step: string;
 /** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
 metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
 * Fires an event from a part of a multi-step flow.
 *
 * @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
 * @param step - The step/part that mounted.
 * @param metadata - Flow-specific metadata sent under `payload.metadata`.
 * @param eventSamplingRate - Override the default full-capture sampling rate.
 * @example
 * telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
 */
export function eventFlowStepMounted(
 flow: string,
 step: string,
 metadata: TelemetryEventRaw['payload'] = {},
 eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
 return {
 event: EVENT_FLOW_STEP_MOUNTED,
 eventSamplingRate,
 payload: {
 flow,
 step,
 metadata,
 },
 };
}

1 change: 1 addition & 0 deletions
packages/shared/src/telemetry/events/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';

13 changes: 13 additions & 0 deletions
packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
 onExit,
 } = useConfigureSSO();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();

 // The activate step is only reachable with a configured connection, so the
 // domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

 try {
 await setConnectionActive(enterpriseConnection.id, true);
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'activate', {
 timestamp: new Date().toISOString(),
 connectionStatus: 'active',
 connectionId: enterpriseConnection.id,
 organizationId: organization?.id ?? null,
 }),
 );
 onExit?.();
 } catch (err) {
 handleError(err as Error, [], card.setError);
Expand Down

26 changes: 24 additions & 2 deletions
packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
 Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
 const {
 enterpriseConnection,
 organizationDomains,
 organizationEnterpriseConnection,
 contentRef,
 organizationDomainMutations: { createDomain, revalidate },
 enterpriseConnectionMutations: { updateConnection },
 } = useConfigureSSO();
 const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

 const hasRecordedTelemetryEvent = useRef(false);
 useEffect(() => {
 if (hasRecordedTelemetryEvent.current) {
 return;
 }

 hasRecordedTelemetryEvent.current = true;
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'verify-domain', {
 timestamp: new Date().toISOString(),
 connectionStatus: organizationEnterpriseConnection.status,
 connectionId: enterpriseConnection?.id ?? null,
 organizationId: organization?.id ?? null,
 }),
 );
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, []);

 const handleCreateDomain = async (domain: string) => {
 card.setError(undefined);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared,ui): Add telemetry event for flow steps by LauraBeatris · Pull Request #8951 · clerk/javascript · GitHub
Skip to content
chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LauraBeatris
merged 5 commits into

from

Jun 23, 2026
 Merged


chore(shared,ui): Add telemetry event for flow steps
#8951
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d65bd65

Add telemetry event


LauraBeatris Jun 22, 2026
242878f

Emit event on activate step


LauraBeatris Jun 22, 2026
ab1cac9

Emit on verify-domain step


LauraBeatris Jun 22, 2026
f1c2675

Emit with organization ID as metadata


LauraBeatris Jun 22, 2026
56719d3

Add changeset


LauraBeatris Jun 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/gold-ends-throw.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow

40 changes: 40 additions & 0 deletions
packages/shared/src/telemetry/events/flow-step.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
 /** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
 flow: string;
 /** The step/part that mounted, e.g. `verify-domain` */
 step: string;
 /** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
 metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
 * Fires an event from a part of a multi-step flow.
 *
 * @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
 * @param step - The step/part that mounted.
 * @param metadata - Flow-specific metadata sent under `payload.metadata`.
 * @param eventSamplingRate - Override the default full-capture sampling rate.
 * @example
 * telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
 */
export function eventFlowStepMounted(
 flow: string,
 step: string,
 metadata: TelemetryEventRaw['payload'] = {},
 eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
 return {
 event: EVENT_FLOW_STEP_MOUNTED,
 eventSamplingRate,
 payload: {
 flow,
 step,
 metadata,
 },
 };
}

1 change: 1 addition & 0 deletions
packages/shared/src/telemetry/events/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';

13 changes: 13 additions & 0 deletions
packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
 onExit,
 } = useConfigureSSO();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();

 // The activate step is only reachable with a configured connection, so the
 // domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

 try {
 await setConnectionActive(enterpriseConnection.id, true);
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'activate', {
 timestamp: new Date().toISOString(),
 connectionStatus: 'active',
 connectionId: enterpriseConnection.id,
 organizationId: organization?.id ?? null,
 }),
 );
 onExit?.();
 } catch (err) {
 handleError(err as Error, [], card.setError);
Expand Down

26 changes: 24 additions & 2 deletions
packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
 Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
 const {
 enterpriseConnection,
 organizationDomains,
 organizationEnterpriseConnection,
 contentRef,
 organizationDomainMutations: { createDomain, revalidate },
 enterpriseConnectionMutations: { updateConnection },
 } = useConfigureSSO();
 const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

 const hasRecordedTelemetryEvent = useRef(false);
 useEffect(() => {
 if (hasRecordedTelemetryEvent.current) {
 return;
 }

 hasRecordedTelemetryEvent.current = true;
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'verify-domain', {
 timestamp: new Date().toISOString(),
 connectionStatus: organizationEnterpriseConnection.status,
 connectionId: enterpriseConnection?.id ?? null,
 organizationId: organization?.id ?? null,
 }),
 );
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, []);

 const handleCreateDomain = async (domain: string) => {
 card.setError(undefined);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared,ui): Add telemetry event for flow steps by LauraBeatris · Pull Request #8951 · clerk/javascript · GitHub
Skip to content
chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LauraBeatris
merged 5 commits into

from

Jun 23, 2026
 Merged


chore(shared,ui): Add telemetry event for flow steps
#8951
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d65bd65

Add telemetry event


LauraBeatris Jun 22, 2026
242878f

Emit event on activate step


LauraBeatris Jun 22, 2026
ab1cac9

Emit on verify-domain step


LauraBeatris Jun 22, 2026
f1c2675

Emit with organization ID as metadata


LauraBeatris Jun 22, 2026
56719d3

Add changeset


LauraBeatris Jun 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/gold-ends-throw.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow

40 changes: 40 additions & 0 deletions
packages/shared/src/telemetry/events/flow-step.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
 /** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
 flow: string;
 /** The step/part that mounted, e.g. `verify-domain` */
 step: string;
 /** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
 metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
 * Fires an event from a part of a multi-step flow.
 *
 * @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
 * @param step - The step/part that mounted.
 * @param metadata - Flow-specific metadata sent under `payload.metadata`.
 * @param eventSamplingRate - Override the default full-capture sampling rate.
 * @example
 * telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
 */
export function eventFlowStepMounted(
 flow: string,
 step: string,
 metadata: TelemetryEventRaw['payload'] = {},
 eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
 return {
 event: EVENT_FLOW_STEP_MOUNTED,
 eventSamplingRate,
 payload: {
 flow,
 step,
 metadata,
 },
 };
}

1 change: 1 addition & 0 deletions
packages/shared/src/telemetry/events/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';

13 changes: 13 additions & 0 deletions
packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
 onExit,
 } = useConfigureSSO();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();

 // The activate step is only reachable with a configured connection, so the
 // domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

 try {
 await setConnectionActive(enterpriseConnection.id, true);
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'activate', {
 timestamp: new Date().toISOString(),
 connectionStatus: 'active',
 connectionId: enterpriseConnection.id,
 organizationId: organization?.id ?? null,
 }),
 );
 onExit?.();
 } catch (err) {
 handleError(err as Error, [], card.setError);
Expand Down

26 changes: 24 additions & 2 deletions
packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
 Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
 const {
 enterpriseConnection,
 organizationDomains,
 organizationEnterpriseConnection,
 contentRef,
 organizationDomainMutations: { createDomain, revalidate },
 enterpriseConnectionMutations: { updateConnection },
 } = useConfigureSSO();
 const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

 const hasRecordedTelemetryEvent = useRef(false);
 useEffect(() => {
 if (hasRecordedTelemetryEvent.current) {
 return;
 }

 hasRecordedTelemetryEvent.current = true;
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'verify-domain', {
 timestamp: new Date().toISOString(),
 connectionStatus: organizationEnterpriseConnection.status,
 connectionId: enterpriseConnection?.id ?? null,
 organizationId: organization?.id ?? null,
 }),
 );
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, []);

 const handleCreateDomain = async (domain: string) => {
 card.setError(undefined);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
chore(shared,ui): Add telemetry event for flow steps by LauraBeatris · Pull Request #8951 · clerk/javascript · GitHub
Skip to content
chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LauraBeatris
merged 5 commits into

from

Jun 23, 2026
 Merged


chore(shared,ui): Add telemetry event for flow steps
#8951
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d65bd65

Add telemetry event


LauraBeatris Jun 22, 2026
242878f

Emit event on activate step


LauraBeatris Jun 22, 2026
ab1cac9

Emit on verify-domain step


LauraBeatris Jun 22, 2026
f1c2675

Emit with organization ID as metadata


LauraBeatris Jun 22, 2026
56719d3

Add changeset


LauraBeatris Jun 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/gold-ends-throw.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow

40 changes: 40 additions & 0 deletions
packages/shared/src/telemetry/events/flow-step.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
 /** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
 flow: string;
 /** The step/part that mounted, e.g. `verify-domain` */
 step: string;
 /** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
 metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
 * Fires an event from a part of a multi-step flow.
 *
 * @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
 * @param step - The step/part that mounted.
 * @param metadata - Flow-specific metadata sent under `payload.metadata`.
 * @param eventSamplingRate - Override the default full-capture sampling rate.
 * @example
 * telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
 */
export function eventFlowStepMounted(
 flow: string,
 step: string,
 metadata: TelemetryEventRaw['payload'] = {},
 eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
 return {
 event: EVENT_FLOW_STEP_MOUNTED,
 eventSamplingRate,
 payload: {
 flow,
 step,
 metadata,
 },
 };
}

1 change: 1 addition & 0 deletions
packages/shared/src/telemetry/events/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';

13 changes: 13 additions & 0 deletions
packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
 onExit,
 } = useConfigureSSO();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();

 // The activate step is only reachable with a configured connection, so the
 // domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

 try {
 await setConnectionActive(enterpriseConnection.id, true);
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'activate', {
 timestamp: new Date().toISOString(),
 connectionStatus: 'active',
 connectionId: enterpriseConnection.id,
 organizationId: organization?.id ?? null,
 }),
 );
 onExit?.();
 } catch (err) {
 handleError(err as Error, [], card.setError);
Expand Down

26 changes: 24 additions & 2 deletions
packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
 Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
 const {
 enterpriseConnection,
 organizationDomains,
 organizationEnterpriseConnection,
 contentRef,
 organizationDomainMutations: { createDomain, revalidate },
 enterpriseConnectionMutations: { updateConnection },
 } = useConfigureSSO();
 const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

 const hasRecordedTelemetryEvent = useRef(false);
 useEffect(() => {
 if (hasRecordedTelemetryEvent.current) {
 return;
 }

 hasRecordedTelemetryEvent.current = true;
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'verify-domain', {
 timestamp: new Date().toISOString(),
 connectionStatus: organizationEnterpriseConnection.status,
 connectionId: enterpriseConnection?.id ?? null,
 organizationId: organization?.id ?? null,
 }),
 );
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, []);

 const handleCreateDomain = async (domain: string) => {
 card.setError(undefined);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared,ui): Add telemetry event for flow steps by LauraBeatris · Pull Request #8951 · clerk/javascript · GitHub
Skip to content
chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LauraBeatris
merged 5 commits into

from

Jun 23, 2026
 Merged


chore(shared,ui): Add telemetry event for flow steps
#8951
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d65bd65

Add telemetry event


LauraBeatris Jun 22, 2026
242878f

Emit event on activate step


LauraBeatris Jun 22, 2026
ab1cac9

Emit on verify-domain step


LauraBeatris Jun 22, 2026
f1c2675

Emit with organization ID as metadata


LauraBeatris Jun 22, 2026
56719d3

Add changeset


LauraBeatris Jun 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/gold-ends-throw.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow

40 changes: 40 additions & 0 deletions
packages/shared/src/telemetry/events/flow-step.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
 /** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
 flow: string;
 /** The step/part that mounted, e.g. `verify-domain` */
 step: string;
 /** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
 metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
 * Fires an event from a part of a multi-step flow.
 *
 * @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
 * @param step - The step/part that mounted.
 * @param metadata - Flow-specific metadata sent under `payload.metadata`.
 * @param eventSamplingRate - Override the default full-capture sampling rate.
 * @example
 * telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
 */
export function eventFlowStepMounted(
 flow: string,
 step: string,
 metadata: TelemetryEventRaw['payload'] = {},
 eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
 return {
 event: EVENT_FLOW_STEP_MOUNTED,
 eventSamplingRate,
 payload: {
 flow,
 step,
 metadata,
 },
 };
}

1 change: 1 addition & 0 deletions
packages/shared/src/telemetry/events/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';

13 changes: 13 additions & 0 deletions
packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
 onExit,
 } = useConfigureSSO();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();

 // The activate step is only reachable with a configured connection, so the
 // domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

 try {
 await setConnectionActive(enterpriseConnection.id, true);
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'activate', {
 timestamp: new Date().toISOString(),
 connectionStatus: 'active',
 connectionId: enterpriseConnection.id,
 organizationId: organization?.id ?? null,
 }),
 );
 onExit?.();
 } catch (err) {
 handleError(err as Error, [], card.setError);
Expand Down

26 changes: 24 additions & 2 deletions
packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
 Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
 const {
 enterpriseConnection,
 organizationDomains,
 organizationEnterpriseConnection,
 contentRef,
 organizationDomainMutations: { createDomain, revalidate },
 enterpriseConnectionMutations: { updateConnection },
 } = useConfigureSSO();
 const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

 const hasRecordedTelemetryEvent = useRef(false);
 useEffect(() => {
 if (hasRecordedTelemetryEvent.current) {
 return;
 }

 hasRecordedTelemetryEvent.current = true;
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'verify-domain', {
 timestamp: new Date().toISOString(),
 connectionStatus: organizationEnterpriseConnection.status,
 connectionId: enterpriseConnection?.id ?? null,
 organizationId: organization?.id ?? null,
 }),
 );
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, []);

 const handleCreateDomain = async (domain: string) => {
 card.setError(undefined);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(shared,ui): Add telemetry event for flow steps by LauraBeatris · Pull Request #8951 · clerk/javascript · GitHub
Skip to content
chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LauraBeatris
merged 5 commits into

from

Jun 23, 2026
 Merged


chore(shared,ui): Add telemetry event for flow steps
#8951
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d65bd65

Add telemetry event


LauraBeatris Jun 22, 2026
242878f

Emit event on activate step


LauraBeatris Jun 22, 2026
ab1cac9

Emit on verify-domain step


LauraBeatris Jun 22, 2026
f1c2675

Emit with organization ID as metadata


LauraBeatris Jun 22, 2026
56719d3

Add changeset


LauraBeatris Jun 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/gold-ends-throw.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow

40 changes: 40 additions & 0 deletions
packages/shared/src/telemetry/events/flow-step.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
 /** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
 flow: string;
 /** The step/part that mounted, e.g. `verify-domain` */
 step: string;
 /** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
 metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
 * Fires an event from a part of a multi-step flow.
 *
 * @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
 * @param step - The step/part that mounted.
 * @param metadata - Flow-specific metadata sent under `payload.metadata`.
 * @param eventSamplingRate - Override the default full-capture sampling rate.
 * @example
 * telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
 */
export function eventFlowStepMounted(
 flow: string,
 step: string,
 metadata: TelemetryEventRaw['payload'] = {},
 eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
 return {
 event: EVENT_FLOW_STEP_MOUNTED,
 eventSamplingRate,
 payload: {
 flow,
 step,
 metadata,
 },
 };
}

1 change: 1 addition & 0 deletions
packages/shared/src/telemetry/events/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';

13 changes: 13 additions & 0 deletions
packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
 onExit,
 } = useConfigureSSO();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();

 // The activate step is only reachable with a configured connection, so the
 // domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

 try {
 await setConnectionActive(enterpriseConnection.id, true);
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'activate', {
 timestamp: new Date().toISOString(),
 connectionStatus: 'active',
 connectionId: enterpriseConnection.id,
 organizationId: organization?.id ?? null,
 }),
 );
 onExit?.();
 } catch (err) {
 handleError(err as Error, [], card.setError);
Expand Down

26 changes: 24 additions & 2 deletions
packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
 Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
 const {
 enterpriseConnection,
 organizationDomains,
 organizationEnterpriseConnection,
 contentRef,
 organizationDomainMutations: { createDomain, revalidate },
 enterpriseConnectionMutations: { updateConnection },
 } = useConfigureSSO();
 const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

 const hasRecordedTelemetryEvent = useRef(false);
 useEffect(() => {
 if (hasRecordedTelemetryEvent.current) {
 return;
 }

 hasRecordedTelemetryEvent.current = true;
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'verify-domain', {
 timestamp: new Date().toISOString(),
 connectionStatus: organizationEnterpriseConnection.status,
 connectionId: enterpriseConnection?.id ?? null,
 organizationId: organization?.id ?? null,
 }),
 );
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, []);

 const handleCreateDomain = async (domain: string) => {
 card.setError(undefined);

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
chore(shared,ui): Add telemetry event for flow steps by LauraBeatris · Pull Request #8951 · clerk/javascript · GitHub
Skip to content
chore(shared,ui): Add telemetry event for flow steps#8951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

LauraBeatris
merged 5 commits into

from

Jun 23, 2026
 Merged


chore(shared,ui): Add telemetry event for flow steps
#8951
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d65bd65

Add telemetry event


LauraBeatris Jun 22, 2026
242878f

Emit event on activate step


LauraBeatris Jun 22, 2026
ab1cac9

Emit on verify-domain step


LauraBeatris Jun 22, 2026
f1c2675

Emit with organization ID as metadata


LauraBeatris Jun 22, 2026
56719d3

Add changeset


LauraBeatris Jun 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
.changeset/gold-ends-throw.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/shared': patch
'@clerk/ui': patch
---

Add a generic `FLOW_STEP_MOUNTED` telemetry event (`eventFlowStepMounted`) for measuring multi-step flow funnels, and wire it into the self-serve SSO flow

40 changes: 40 additions & 0 deletions
packages/shared/src/telemetry/events/flow-step.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
import type { TelemetryEventRaw } from '../../types';

const EVENT_FLOW_STEP_MOUNTED = 'FLOW_STEP_MOUNTED';
const EVENT_SAMPLING_RATE = 1;

type EventFlowStepMounted = {
 /** The flow the step belongs to, e.g. `configureSSO` (mirrors `Flow.Root`'s `flow`). */
 flow: string;
 /** The step/part that mounted, e.g. `verify-domain` */
 step: string;
 /** Free-form, flow-specific metadata supplied by the caller (e.g. `timestamp`, `connectionStatus`). */
 metadata: TelemetryEventRaw['payload'];
} & TelemetryEventRaw['payload'];

/**
 * Fires an event from a part of a multi-step flow.
 *
 * @param flow - The flow identifier (matches `Flow.Root`'s `flow`).
 * @param step - The step/part that mounted.
 * @param metadata - Flow-specific metadata sent under `payload.metadata`.
 * @param eventSamplingRate - Override the default full-capture sampling rate.
 * @example
 * telemetry.record(eventFlowStepMounted('configureSSO', 'verify-domain', { timestamp: new Date().toISOString(), connectionStatus: 'unconfigured' }));
 */
export function eventFlowStepMounted(
 flow: string,
 step: string,
 metadata: TelemetryEventRaw['payload'] = {},
 eventSamplingRate: number = EVENT_SAMPLING_RATE,
): TelemetryEventRaw<EventFlowStepMounted> {
 return {
 event: EVENT_FLOW_STEP_MOUNTED,
 eventSamplingRate,
 payload: {
 flow,
 step,
 metadata,
 },
 };
}

1 change: 1 addition & 0 deletions
packages/shared/src/telemetry/events/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
export * from './component-mounted';
export * from './flow-step';
export * from './method-called';
export * from './framework-metadata';
export * from './theme-usage';

13 changes: 13 additions & 0 deletions
packages/ui/src/components/ConfigureSSO/steps/ActivateStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
import { useClerk, useOrganization } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';

import { Button, Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState } from '@/elements/contexts';
import { ChevronRight, DuotoneShieldCheck } from '@/icons';
Expand All@@ -15,6 +18,8 @@ export const ActivateStep = (): JSX.Element => {
 onExit,
 } = useConfigureSSO();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();

 // The activate step is only reachable with a configured connection, so the
 // domains are set; join multiples for the subtitle copy.
Expand All@@ -31,6 +36,14 @@ export const ActivateStep = (): JSX.Element => {

 try {
 await setConnectionActive(enterpriseConnection.id, true);
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'activate', {
 timestamp: new Date().toISOString(),
 connectionStatus: 'active',
 connectionId: enterpriseConnection.id,
 organizationId: organization?.id ?? null,
 }),
 );
 onExit?.();
 } catch (err) {
 handleError(err as Error, [], card.setError);
Expand Down

26 changes: 24 additions & 2 deletions
packages/ui/src/components/ConfigureSSO/steps/OrganizationDomainsStep.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { useUser } from '@clerk/shared/react';
import { useClerk, useOrganization, useUser } from '@clerk/shared/react';
import { eventFlowStepMounted } from '@clerk/shared/telemetry';
import type { OrganizationDomainResource } from '@clerk/shared/types';
import type React from 'react';
import { useState } from 'react';
import { useEffect, useRef, useState } from 'react';

import {
 Badge,
Expand DownExpand Up@@ -40,14 +41,35 @@ export const OrganizationDomainsStep = (): JSX.Element => {
 const {
 enterpriseConnection,
 organizationDomains,
 organizationEnterpriseConnection,
 contentRef,
 organizationDomainMutations: { createDomain, revalidate },
 enterpriseConnectionMutations: { updateConnection },
 } = useConfigureSSO();
 const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
 const card = useCardState();
 const clerk = useClerk();
 const { organization } = useOrganization();
 const [domainToRemove, setDomainToRemove] = useState<OrganizationDomainResource | null>(null);

 const hasRecordedTelemetryEvent = useRef(false);
 useEffect(() => {
 if (hasRecordedTelemetryEvent.current) {
 return;
 }

 hasRecordedTelemetryEvent.current = true;
 clerk.telemetry?.record(
 eventFlowStepMounted('configureSSO', 'verify-domain', {
 timestamp: new Date().toISOString(),
 connectionStatus: organizationEnterpriseConnection.status,
 connectionId: enterpriseConnection?.id ?? null,
 organizationId: organization?.id ?? null,
 }),
 );
 // eslint-disable-next-line react-hooks/exhaustive-deps
 }, []);

 const handleCreateDomain = async (domain: string) => {
 card.setError(undefined);

Expand Down
Loading