user-preferences

Track Onboarding Event

Track an onboarding event for analytics.

TECH-776: Fire-and-forget event tracking. Events are used for funnel analysis, time-to-value metrics, and company-level onboarding health monitoring.

The is_replay flag is automatically set based on whether the user has previously completed the chapter being tracked.

post/api/v1/auth/preferences/onboarding/events

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/auth/preferences/onboarding/events
  • Auth: none declared

Headers

Authorizationstring

Request body

event_typestring required

Event type (CHAPTER_STARTED, STEP_ADVANCED, CHAPTER_COMPLETED, etc.)

chapterstring required

Chapter ID (connect, discover, freshness, schema)

stepinteger nullable

0-indexed step number within chapter

step_idstring nullable

Human-readable step identifier

metadataobject nullable

Additional event context as JSON

session_idstring nullable

UUID grouping events in a single session

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.