Skip to main content
POST
/
v1
/
onboarding
/
steps
/
{step}
/
complete
Complete Onboarding Step
curl --request POST \
  --url https://api.example.com/v1/onboarding/steps/{step}/complete \
  --header 'Authorization: Bearer <token>'
{
  "step": "<string>",
  "completed": true,
  "onboarding": {
    "current_step": "<string>",
    "completed_steps": [
      "<string>"
    ],
    "workspace_created": true,
    "members_invited": 123,
    "connectors_connected": 123,
    "alert_rule_created": true,
    "first_sync": {
      "status": "<string>",
      "issues_ingested": 0
    },
    "updated_at": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
step
string
required

Onboarding step ID to mark complete

Response

Successful Response

​
step
string
required
​
completed
boolean
required
​
onboarding
OnboardingStateResponse · object
required

Flattened onboarding state returned by the API.

Maps the internal _SEED_ONBOARDING dict to a clean response shape. Spec shape (C-022): current_step, completed_steps, workspace_created, members_invited, connectors_connected, alert_rule_created, first_sync, updated_at