DeviceSetup Interface¶
Note: This feature requires Amazon to allowlist your device. For help, contact your Amazon Solutions Architect or partner manager.
After the user signs in to your application during or after the out-of-box experience, your application starts the Engine and publishes the DeviceSetup.SetupCompleted
message to notify Alexa that the setup is complete. The Engine publishes the DeviceSetup.SetupCompletedResponse
to your application to indicate Alexa was notified successfully. In response to the SetupCompleted
event, Alexa starts an onboarding experience including a short first-time conversation with the user.
Because SetupCompleted
triggers an onboarding experience, do not publish the message if the signed-in user has already seen the experience. The onboarding experience is for first-time users only and might differ for returning users.
Note: Do not publish the
SetupCompleted
message if user is in Connectivity mode or Preview Mode or if the user has disabled hands-free listening. PublishingSetupCompleted
in these conditions causes undesirable user experience.