Onboarding
3 methods on the Onboarding resource.
3 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";3 of 3
completeOnboarding
Mark first-run onboarding as completed
compozy.onboarding.completeOnboarding() → Promise<OnboardingStatusResponse>
POST /api/onboarding/completeapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.onboarding.completeOnboarding();getOnboardingStatus
Get the first-run onboarding completion status
compozy.onboarding.getOnboardingStatus() → Promise<OnboardingStatusResponse>
GET /api/onboardingapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.onboarding.getOnboardingStatus();resetOnboarding
Clear the onboarding completion flag
compozy.onboarding.resetOnboarding() → Promise<OnboardingStatusResponse>
DELETE /api/onboardingapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.onboarding.resetOnboarding();