Sign in
latestOpenAPI 3.1.02026-08-1013317298.0 KB

d94e0e0f1821

Onboarding

Record an onboarding checkpoint

Records that a user has reached or completed an onboarding checkpoint.

Called by events-notifier after validating a Segment webhook. Not intended to be called directly from the browser.

Checkpoints (1–7):

  1. Authentication Started
  2. Auth Method Selected
  3. Profile Creation
  4. Avatar Creator Started
  5. Download Page Viewed
  6. Download Clicked
  7. Launcher Ready

Implicit completion: Recording checkpoint N automatically marks checkpoint N-1 as completed.

post/onboarding/checkpoint

Request body

checkpointIdinteger required

Onboarding checkpoint identifier (1–7)

userIdentifierstring required

User identifier (email address or wallet address)

identifierType'email' | 'wallet' required

Type of user identifier

action'reached' | 'completed' required

Whether the user reached or completed this checkpoint

emailstring email

User's email address (used for nudge emails)

sourcestring

Source of the checkpoint event (e.g. "auth", "website", "launcher")

metadataobject

Additional context (e.g. loginMethod)

Response

Checkpoint recorded

successboolean required