Overview

IoT OS collects data from devices over Sparkplug B, stores it with its quality and age, and lets people and software act on it. These docs are for engineers who connect devices to it and build applications on it.

Integration API referenceEvery operation an application can call, with the abilities it needs and its rate limits.

Events and webhooksThe ordered event feed, the event types and the signed webhook delivery.

User guidesThe same guides people read inside the portal: devices, profiles, dashboards, alerts and automations.

ChangelogChanges to the integration API, its events and the SDK.

What these docs describe

They describe the hosted service as it runs today. The reference and the user guides are generated from the release customers use, and features that aren’t switched on for the hosted service aren’t documented. To report something that doesn’t match what you see, use the link at the bottom of any page.

To use the API you need an application and a token, created in the portal under Connect → Integrations by someone with permission to manage devices. Keep the token on your server.