Onboarding

Onboarding checkpoint tracking for email nudge campaigns (internal, requires API key)

Record an onboarding checkpoint

post

https://auth-api.decentraland.orghttps://auth-api.decentraland.zonehttp://localhost:3000

/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.

Authorizations

bearerAuth

AuthorizationstringRequired

API key passed as Bearer token. Required for onboarding endpoints.

Body

application/json

checkpointIdinteger · min: 1 · max: 7Required

Onboarding checkpoint identifier (1–7)

userIdentifierstringRequired

User identifier (email address or wallet address)

identifierTypestring · enumRequired

Type of user identifier

Possible values:

actionstring · enumRequired

Whether the user reached or completed this checkpoint

Possible values:

emailstring · emailOptional

User's email address (used for nudge emails)

sourcestringOptional

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

Responses

200

Checkpoint recorded

application/json

successbooleanRequired

400

Invalid payload (missing fields, invalid checkpointId, invalid identifierType)

application/json

401

Missing or invalid API key

application/json

500

Internal server error (e.g. database failure)

application/json

post/onboarding/checkpoint

HTTPcURLJavaScriptPython

POST /onboarding/checkpoint HTTP/1.1
Host: auth-api.decentraland.org
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "checkpointId": 3,
  "userIdentifier": "[email protected]",
  "identifierType": "email",
  "action": "reached",
  "email": "[email protected]",
  "source": "auth",
  "metadata": {
    "loginMethod": "email"
  }
}

User reached a checkpointMark a checkpoint as completed

{
  "success": true
}