Measurement Webhooks
Multiple Webhooks
Multiple Webhooks can be added at the same time. The default behavior is for measurements to be sent to all Webhooks.
Device Specific Webhooks
Users can configure devices to only POST to a single, user-selected Webhook using the measurement_webhook_id
Device Property. See Using Device Properties with Webhooks for more information.
Multiple Metrics & Post as Array
For devices that measure multiple metrics simultaneously (e.g. BPMs measure both blood_pressure
and pulse
metrics in a single physical reading), webhooks can be configured to either send two separate POST requests for each measurement, or a single POST request with all simultaneous measurements included in a JSON array.
For either option, the timestamp
field will be identical for coincident measurements. If multiple measurements of the same type are reported with the same timestamp, clients can use the measurement_index
value included in the filter_params
field to identify coincident measurements.
Examples of Posting as an array can be found in our FAQs.
Measurement Webhook Structure
Parameter | Description |
---|---|
metric | The type of metric. See the Device Overview documentation for a list of valid metrics for each of our devices. |
device_name | The name of the device |
hwi_device_id | The unique id returned when activating a HWI Device. This can be used to identify measurements by activated HWI Devices |
patient_id | The internal patient ID associated with this device, if it was provided when the device was requested (see Activating Devices) |
hardware_uuid | A unique identifier associated with the Tenovi Gateway (printed on the back). This is primarily useful for troubleshooting, or if a replacement Gateway is needed (Tenovi must be provided 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 Devices for valid sensor codes) |
value_1 | A first measurement value (formatted as a numeric string with 2 decimal places). See the Device Overview documentation for the values associated with each metric type. |
value_2 | A second measurement value (also formatted as a numeric string with 2 decimal places). See the Device Overview documentation for the secondary values associated with each metric type. |
created | A timestamp (in UTC) of when the measurement was RECEIVED by our server in YYYY-MM-DDTHH:MM:SS.ssssssZ format. |
timestamp | A timestamp (in UTC) of when the measurement was TAKEN (as measured by the device) in YYYY-MM-DDTHH:MM:SS.ssssssZ format. |
timezone_offset | Offset (in hours) between timezone where measurement was taken and UTC. Can be negative. |
estimated_timestamp | Boolean indicating if the timestamp field is an algorithmic estimate, which is used if the timestamp reported by the sensor device was in an invalid range. See FAQ for more details. |
filter_params | A json object with any additional context information in key-value pairs. See the Device Overview documentation for the possible filter_param values associated with each Device type. |