API
Last updated:
The Hirro API gives your own tools the same data the dashboard shows. Read assets with their zones, stages and history, push assets in from your asset register, and receive webhooks when something changes, such as an asset leaving the yard. It suits BI tools, custom ERP links and internal apps.
What can I read through the API?
Section titled “What can I read through the API?”| Resource | What it holds |
|---|---|
| Assets | Number, name, type, zone, stage, last sighting, parent and ERP item |
| Sites and zones | The sites you set up and the zones drawn on them |
| Sightings | Which listener heard which tag, and when |
| Events | Zone changes, stage changes, departures and returns |
| Tags | Each tag, its asset and its battery level |
What can I write through the API?
Section titled “What can I write through the API?”Create and update assets, for example from your asset register, and link tags to assets.
What are webhooks for?
Section titled “What are webhooks for?”Webhooks send an event to your system the moment it happens, so you do not have to poll. Typical events are an asset changing zone or stage, an asset leaving or returning through the gate, and an attachment that did not come back with its parent.
Which plan includes the API?
Section titled “Which plan includes the API?”The API is part of the Scale and Enterprise plans. See Plans.