SmartFlex Onboarding V2
In order to onboard a customer to SmartFlex, they must be directed to register a device with Kraken and, if relevant, switch to an appropriate tariff.
📣 Note: SmartFlex Onboarding does not handle tariff switching. If you want the customer to be on a specific tariff, you will need to handle this separately.
Onboarding Wizard​
To onboard a device, the user must progress through the onboarding wizard by fetching
and completing the current onboarding step until the current step returns null
, signifying a successful onboarding.
Start onboarding wizard​
To begin a new onboarding journey, you can use the following mutation:
Cancel onboarding wizard​
If you want to cancel an onboarding journey, you can use the following mutation:
Fetch onboarding wizard(s)​
This is useful for:
- Polling the current step, e.g. in the case of waiting for DeviceRegistration to complete.
- Returning a user to an onboarding wizard if they leave it.
Onboarding Step​
The step order is dynamic, so when fetching the current step the query must be ready to accept any step type. An example of how this could look is as follows (note: this example does not include all possible step types):
Steps have their own custom mutations that must be called in order to complete the step and enable the user to move to the next step.