Device type agnostic onboarding steps
Select device type
When is this step returned?
This step is returned when the user needs to select the type of device they intend to onboard.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the selected device type.
Try out completing this step
Authentication
When is this step returned?
This step is returned if the user needs to complete an authentication flow with their device's OEM (Original Equipment Manufacturer). The step contains an authorizationUri, which will take the the user to the OEM for authentication.
Try out fetching this step
What is needed to complete this step?
This step is completed by calling the mutation below with the continuation uri received from the OEM after authentication.
Try out completing this step
Select session device
When is this step returned?
This step is returned if the user has multiple devices connected to their OEM's account and they need to select a single device to onboard. The step contains a list of options that the user can choose from.
Try out fetching this step
What is needed to complete this step?
It can be completed by using the `selectFromListForSmartFlexOnboarding` mutation with the `id` of the desired option as the `selectedOption` input.
Try out completing this step
Unsupported combination​
If the UnsupportedCombination step is returned as the current step, it means that the selected
device combination is not compatible with other devices currently onboarded to the users account.
This step cannot be completed and the user must select different device options to continue.
User input required
When is this step returned?
This step is returned if the onboarding journey requires some information from the user to proceed (e.g. vehicle identification number). The step contains a list of the requested user inputs that should be submitted to proceed. Note that all inputs marked as required must be provided to proceed.
Try out fetching this step
What is needed to complete this step?
It can be completed by using the `completeUserInputRequiredForSmartFlexOnboarding` mutation
Try out completing this step
Waiting steps​
Waiting steps pause onboarding until an external event advances the wizard. They are not completed by a customer action:
WaitForLiveIntegrationwaits for the selected device integration to become available.WaitForTransitionwaits for the device to move to its next onboarding state.
Refetch currentStep through smartFlexOnboardingWizards to check when onboarding can continue.
Foundation currently renders WaitForLiveIntegration, but not WaitForTransition.