Skip to main content

Fields

backendScreen : BackendScreenType

A Backend Screen that renders the SmartFlex onboarding wizard.

Arguments
maxVersionSupported : Int default: 1

The maximum version of Backend Screens supported by the client.

The completed steps for all onboarding wizards that are currently in progress. Note: - The last step is the most recent one. - If an onboarding journey is completed, it will not be included in this list.

The next step of the SmartFlex onboarding wizard. Returns None if the onboarding journey is completed.

deviceType : KrakenFlexDeviceTypes

The onboarding wizard's selected device type to be onboarded.

displayName : String

The onboarding wizard's display name extracted from the wizard's selected device attributes.

id : ID! required

A unique identifier for this SmartFlex onboarding wizard.

isComplete : Boolean! required

Returns true if the onboarding wizard has been completed, false otherwise.

resumable : SmartFlexResumable

Determines whether the wizard's onboarding journey can be resumed.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "backendScreen": ComponentListType, "completedSteps": SmartFlexOnboardingStepInterface, "currentStep": SmartFlexOnboardingStepInterface, "deviceType": "BATTERIES", "displayName": "light-have-world-always-mother", "id": "69505399", "isComplete": true, "resumable": SmartFlexResumable }