Skip to content
Stand with Ukraine flag

Device claiming widget

  • Widget
  • v1.0.0
  • Sep 1, 2026
  • MIT license
  • v4.2+ | Built-in
Device claiming widget

Allows to claim the device using name and optional secret key.

Widget Type
  • Static
Category
  • Input Forms

Who it’s for

Anyone running a self-service device onboarding flow — a customer unboxing a sensor and adding it to their own account, a technician assigning a pre-provisioned unit to a site. The device already exists on the platform; claiming is how it becomes the customer’s.

What it does

The Device claiming widget lets a user claim a pre-provisioned device by entering its name and, optionally, a secret key printed on the unit. On success the device is assigned to the claiming user’s customer, which is what turns a warehouse of provisioned devices into a self-service onboarding step.

  • Self-service onboarding — the customer performs the assignment rather than raising a request with whoever administers the platform.
  • The secret key field can be required or hidden, which is the difference between a device anyone knowing the name can claim and one that needs the code on the label.
  • Field labels can be shown or hidden, so the form fits both a guided onboarding page and a compact panel.
  • The claiming button’s label is editable to match the wording of the surrounding flow.
  • The Device claiming widget claims what already exists: the device must be provisioned and claimable beforehand, and the widget creates nothing.

How to set up

Data keys

The Device claiming widget takes no datasource and no data keys — it acts on the device name entered into the form. The default configuration carries a leftover demo datasource, which can be removed.

Form

SettingDefaultEffect
Show ‘Secret key’ input fieldOnRequires the secret alongside the device name
Show labelsOnPrints the field captions
Claiming button labelPlatform defaultThe text on the button
Widget titlePlatform defaultThe caption above the form

Provision the devices with claiming enabled and a secret before publishing the dashboard. The widget is the front end of a platform capability, and nothing it offers works on a device that was not prepared for claiming.

How to customize

  • To claim by name alone — turn off Show ‘Secret key’ input field, accepting that anyone who knows or guesses a device name can then claim it.
  • To fit a compact panel — turn off Show labels where the placeholders alone are clear enough.
  • To match the onboarding wording — set the Claiming button label and the Widget title to the language the rest of the flow uses.

Tips

  • Keep the secret key field on for anything a customer claims themselves. Device names are frequently sequential or predictable, and name-only claiming means a customer can take a device that is not theirs by typing a plausible name.
  • Put the widget on a dashboard that explains where the secret is printed. The claiming step usually fails not because the platform rejected it but because the person could not find the code on the box.

Share Your Widget with the Community

Built a custom widget? Export it as a JSON from ThingsBoard and publish it to the IoT Hub through a simple 4-step wizard (Upload, Listing, Readme, Review & Submit). Share it with thousands of ThingsBoard developers worldwide and get featured in the catalog.