Typical Dataflow
The following describes how data typically flows (with measurment metrics and fulfillment updates) when working with the HWI API. It is highly recommended to make use of webhooks, however, the API also has a series of GET requests that can also be used to get this data.
Measurement Data
Section titled “Measurement Data”Using webhooks, you can receive measurement data in near real-time. When working with Bluetooth enabled devices that connect to the Tenovi Gateway, data typically flows:
- Measurement is taken on a device and data is transmitted to the Tenovi Gateway
- The Tenovi Gateway transmits data to Tenovi servers
- Tenovi servers relay the data out to webhooks you define
flowchart
MD["<strong><a href="/devices">Device</a></strong>\nBPM · Scale · Glucometer\nPulse Ox · Thermometer"]
GW["<strong><a href="/hwi-api/gateways/">Tenovi Gateway</a></strong>\nCellular-connected hub"]
TC["<strong>Tenovi Cloud</strong>\nData ingestion & storage"]
WH["<strong><a href="/hwi-api/webhooks/webhooks-overview/">Webhook / API</a></strong>\nHTTPS POST · REST"]
YA["<strong>Your Application</strong>\nEHR · RPM Platform · Custom App"]
MD -->|" Bluetooth "| GW
GW -->|" Cellular / LTE "| TC
TC -->|" Near Real-time push "| WH
WH -->|" JSON payload "| YA
style MD fill:#cdeaf5,stroke:#29ade3,color:#000
style GW fill:#cdeaf5,stroke:#29ade3,color:#000
style TC fill:#cdeaf5,stroke:#29ade3,color:#000
style WH fill:#cdeaf5,stroke:#29ade3,color:#000
style YA fill:#cdeaf5,stroke:#29ade3,color:#000
There are some exceptions to this data flow depending on the device. The Tenovi Watch for example offloads data at set times throughout the day. You can get more information on these exceptions on our Device Overview page.
If you are using a cellular enabled device without the use of a Tenovi Gateway, your data will flow directly from the device and up to Tenovi servers, before being relayed out to your webhooks.
Fulfillment Data
Section titled “Fulfillment Data”When working with devices that are dropshipped from Tenovi, you can expect to get updates on your fulfillment request throughout the device’s journey to the patient. You will receive status updates to your fulfillment webhooks when:
Shipped- the order is on it’s way through our shipment carriersDelivered- the order has arrived with the patient but no measurements have been taken yetConnected- the patient has taken their first measurementReplaced- the device has been replaced (the new hardware_uuid will be included, if applicable)Unlinked- the device has been unlinked (data will stop flowing and monthly charges will be halted)
More details on our fulfillment process can be found on our Fulfillment Webhooks document.
Special/Bulk Order Data
Section titled “Special/Bulk Order Data”When working with bulk orders, supplies, replacements, or returns you can expect to get updates on your special order webhooks that you define on the HWI Settings screen. More details on these special orders can be found on our Special/Bulk Order Webhooks document.