Skip to main content

UserOnboarding

Details about a user's onboarding state

type UserOnboarding {
  active: Boolean!
  announcement: UserOnboardingAnnouncement
  currentStep: UserOnboardingStep
  earningsEstimate: DollarFormats
  id: ID!
  questions: [UserOnboardingQuestion!]!
}

Fields​

UserOnboarding.active ● Boolean! non-null scalar​

Is the user's onboarding state active?

UserOnboarding.announcement ● UserOnboardingAnnouncement object​

Announcement to display to user upon onboarding completion

UserOnboarding.currentStep ● UserOnboardingStep enum​

The user's current onboarding step

UserOnboarding.earningsEstimate ● DollarFormats object​

The estimate for how much the user can potentially earn

UserOnboarding.id ● ID! non-null scalar​

The user onboarding's ID

UserOnboarding.questions ● [UserOnboardingQuestion!]! non-null object​

User's available onboarding questions

Member of​

Viewer object ● ViewerCompleteOnboardingStepPayload object