BioT Notification Plugins

BioT notification plugins are called when certain actions are completed successfully. BioT is not affected by the plugin response; success or failure.

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

ParameterDescriptionFormat
entityTypeNameThe entity type that you would like to be notified about.
See the API documentation for available values.
Mandatory.
String
actionNameThe action performed on the entity that you would like to be notified about.
See the API documentation for available values.
Mandatory.
String
endpointA valid URI for the platform to call when the event is triggered.
Mandatory.
String

Notification that you can subscribe to:

EntityDescriptionAvailable Actions
caregiverAny user based on the caregiver template_create
_delete
_incomingSms
_login
_logout
_update
_updateEnabledState
commandDevice command related actions_create
_delete
_start
_stop
_update
deviceAny device in the system_activateCertificate
_command
_create
_delete
_generateCertificate
_revokeCertificate
_update
device-alertDevice alert related actions_clear
_create
_delete
_update
generic-entityAny entity based on the generic entity template_create
_delete
_update
organizationAny organization in the system_create
_delete
_update
_updateAdmin
organization-userAny user based on the organization-user template_create
_delete
_incomingSms
_login
_logout
_update
_updateEnabledState
patientAny user based on the patient template_create
_delete
_incomingSms
_login
_logout
_saveMeasurement
_saveMeasurementBulk
_update
_updateEnabledState
patient-alertPatient alert related actions_clear
_create
_delete
_update
Registration Code:Self user registration code_create
_delete
_update
usage-sessionRegular or remote usage sessions_create
_delete
_remotePause
_remoteResume
_remoteStart
_remoteStop
_update

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"
}