Skip to content

Event reference

The runtime generates a mix of automatic behavior events and developer-defined custom events. Treat your custom events as the durable contract you own.

CategoryProduced when
session_startA new browser session begins.
page_viewThe SDK initializes, a supported SPA route changes, or page() is called.
clickAn eligible interactive click is captured.
scrollAn enabled scroll milestone is reached.
rage_clickRepeated nearby clicks meet the rage-click configuration.
funnelA defined funnel advances or completes.
identifyidentify() runs.

Calling event(name, properties?) produces the custom category with your event name and JSON-serializable property object.

window.analytics.event("onboarding_completed", {
flow: "self_serve",
elapsed_seconds: 87,
});

Funnel definitions advance automatically when matching page views or custom events occur. A page funnel uses exact paths or a trailing /* wildcard; an event funnel uses custom-event names.

window.analytics.defineFunnel("trial_activation", [
{ event: "workspace_created" },
{ event: "teammate_invited" },
{ event: "first_project_created" },
]);

The public API does not expose a manual per-step function. Define the funnel once, then emit the application events that represent its steps.

Event properties reach behavior analytics. Do not put free-form user input, credentials, payment data, or unnecessary personal data in them.