OBJECT

OnboardingItem

An onboarding item that has something for the client to complete

link GraphQL Schema definition

  • type OnboardingItem {
  • # The URL to go to to edit the attached object
  • attached_object_edit_url: String
  • # Custom text above the billing info screen
  • billing_disclaimer: String
  • # Return the ID of the associated completed form_answer_group
  • completed_form_id: String
  • # The completed onboarding item for the given user id (from args)
  • completed_onboarding_item: CompletedOnboardingItem
  • # The relevant date to show
  • date_to_show: String
  • # The display name for the onboarding item (based off the attached object)
  • display_name: String
  • # Onboarding item has matrix field
  • has_matrix_field: Boolean
  • # The unique identifier of the onboarding item
  • id: ID!
  • # Return the ID of the incomplete form
  • incomplete_form_id: String
  • # Show if it the last item in related onboarding flow
  • #
  • # Arguments
  • # custom_module_forms_only: Show if it the last item in related
  • # onboarding flow
  • is_last_item(custom_module_forms_only: Boolean): Boolean
  • # Whether the user can skip this onboarding item
  • is_skippable: Boolean!
  • # The ID of the associated item
  • item_id: String
  • # The type of item attached to this onboarding item
  • item_type: String
  • # The user group this onboarding flow is assigned to
  • onboarding_flow: OnboardingFlow
  • # ID of the onboarding flow
  • onboarding_flow_id: ID
  • # Custom text above the photo ID screen
  • photo_id_disclaimer: String
  • # Custom text above the insurance policy screen
  • policy_disclaimer: String
  • # Owner of this onboarding item
  • user: User
  • # The URL to view the onboarding item
  • view_url: String
  • # Custom text for the welcome screen
  • welcome_text: String
  • }