Device Onboarding

To get your users devices connected to your Ignite Signals organisation you need to use our onboarding component.

Usage

To get started onboarding your user's devices you first need to call the deviceWorkflow.registerDevice() endpoint. This endpoint starts the enrollment process for a new device to your organisation.

These tokens can be safely provided to a users end browser to enable them to retrieve data directly from Ignite Signals for their device. They are scoped to workflow related processes for onboarding the specific device.
Tokens expire!! - note that tokens do expire within a period that is configurable by your organisation. Typically this is 5 minutes. If a user does not onboard their device during this period you will need to generate a new workflow token.
<SignalsOnboarding
  :workflow-tokens="[
    'your_workflow_token_1',
    'your_workflow_token_2'
  ]"
  organisation-name="SkyNet"
  organisation-logo="/some-skynet/logo.png"
  @complete="onOnboardingComplete"
  @error="onOnboardingError"
/>

Props

  • workflow-tokens - the tokens to be used for onboarding
  • organisation-name - your Organisation name to be used throughout the onboarding process
  • organisation-logo - (optional) a uri for a img tag src compatible logo

Events

  • complete - triggered when all workflows have been completed successfully
  • error - triggered when an error occurs during onboarding (this error is passed as a parameter to your function)