BioT Notification Plugins
BioT notification plugin is invoked when a predefined event occurs in BioT. Once invoked, the plugin executes, but BioT doesn't monitor the result
High Level Flow

Subscribing to Events
To subscribe to an API, call the subscribe API of the service:
POST https://your-biot-domain.com/dispatcher/v1/hooks/notifications/subscribe
Parameter | Description | Format |
---|---|---|
entityTypeName | The entity type that you would like to be notified about. | String |
actionName | The action performed on the entity that you would like to be notified about. | String |
endpoint | A valid URI for the platform to call when the event is triggered. | String |
Notification that you can subscribe to:
Entity | Description | Available Actions |
---|---|---|
caregiver | Any user based on the caregiver template |
|
command | Device command related actions |
|
device | Any device in the system |
|
device-alert | Device alert related actions |
|
generic-entity | Any entity based on the generic entity template |
|
organization | Any organization in the system |
|
organization-user | Any user based on the organization-user template |
|
patient | Any user based on the patient template |
|
patient-alert | Patient alert related actions |
|
Registration Code: | Self user registration code |
|
usage-session | Regular or remote usage sessions |
|
Unsubscribing from Events
Using the same dispatcher service, you can unsubscribe from an event.
To unsubscribe from an event, call the unsubscribe API of the service:
POST https://your-biot-domain.com/dispatcher/v1/hooks/notifications/unsubscribe
The call body JSON should be the same as the subscribed call.
Unsubscribe from events call body example:
{
"entityTypeName": "device",
"actionName": "_create",
"endpoint": "string"
}
Updated 1 day ago