Fulfillment Webhooks

If Tenovi will be providing fulfillment services, after a Device has been requested, Tenovi will send a callback HTTPS POST request to a provided endpoint to indicate the device status (e.g. “Shipped” or “Connected”), tracking link, and the unique hardware_uuid for the physical device that was shipped to the patient.

Fulfillment Webhook Structure

The following data is included in each fulfillment webhook POST request:

Parameter	Description
hwi_device_id	The unique id returned when activating a HWI Device, which should be used to link shipping updates to a particular Patient or HWI Device in the Client’s software.
patient_id	The patient ID associated with this device, if it was provided when the device was requested (see Activating/Requesting Devices)
hardware_uuid	A unique identifier associated with the Tenovi Gateway. This is primarily useful for troubleshooting, or if a replacement Gateway is needed (Tenovi must be provided with the old ID so they can replace it with the new ID after a replacement unit is shipped out). Do NOT use this field to associate measurements with a patient, as it will change if a Gateway is replaced.
sensor_code	The sensor code of the device (see Activating/Requesting Devices for valid sensor codes)
device_name	The name of the Device that was shipped (i.e. “Tenovi Scale”, “Tenovi BPM”, “Tenovi Pulse Ox”, or “Tenovi Glucometer”). See our Device Overview page for a complete listing of avaiable device types.
status	The status of the device. Options are: “Pending Shipment" "Dropship Requested" "Shipped" "Dropshipped" "Delivered" "Returned" "Connected" "Replaced" "Unlinked" "Client Action Required" "On Hold" "Ready to Ship”
tracking_link	The tracking link for this device, if it has been shipped

Fulfillment/Device Status Definitions

Pending Shipment: A request for a device to be fulfilled by the client hasn’t been fulfilled yet.
Dropship Requested: A request to dropship a device has been made but has yet to leave Tenovi warehouses.
Shipped: A request has been shipped by the client.
Dropshipped: A dropship request has left Tenovi warehouses.
Delivered: The patient has the device in their possession and is ready to be plugged in and start sending data once a measurment is taken.
Returned: A device has been returned to Tenovi’s warehouses.
Connected: A device is connected and has sent measurement data.
Replaced: A device has been replaced with a new device, see more detailed notes below.
Unlinked: A device has been unlinked and can be re-used or repurposed.
Client Action Required: The client needs to update a request before it can be processed if, for example, the address is invalid or it is flagged as a duplicate request.
On Hold: A request is temporarily on hold at Tenovi (for example, if the requested device is temporarily out of stock).
Ready to Ship: A request has passed our automated internal validation and is now ready for internal processing.

Replacement Devices & Gateways

When a replacement Gateway or IMEI is shipped, the fulfillment webhook status will be “Replaced”. This indicates that a new device has been associated with one or more HWI Devices.

If you are requesting a replacement Gateway, Tenovi will automatically update the hardware_uuid of any HWI Devices linked to the same Gateway as the referenced HWI Device. Our system will send a Fulfillment Webhook with the updated Gateway ID when the replacement is shipped.

If multiple HWI Devices were linked to the original Gateway, each will generate its own “Replaced” webhook.

The fulfillment webhook payload will have the following for all replacements Tenovi ships.

hardware_uuid: The new Gateway ID or IMEI sent as a replacement
device_id: The old Gateway ID or IMEI that was replaced
status: Always “Replaced” in this context

You can find more detailed information on our Replacing Devices & Gateways doc.

Example JSON Payload

{
    "hwi_device_id": "12345678-abcd-1234-abcd-1234567890ab",
    "patient_id": "12345678-1234-12345678",
    "hardware_uuid": "fed091a643ff",
    "sensor_code": "10"
    "device_name": "Tenovi BPM",
    "status ": "Shipped",
    "tracking_link": "https://ups.com/tracking-number"
}