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

Parameter	Description	Format
entityTypeName	The entity type that you would like to be notified about. See the API documentation for available values. Mandatory.	String
actionName	The action performed on the entity that you would like to be notified about. See the API documentation for available values. Mandatory.	String
endpoint	A valid URI for the platform to call when the event is triggered. Mandatory.	String

Notification that you can subscribe to:

Entity	Description	Available Actions
caregiver	Any user based on the caregiver template	_create _delete _incomingSms _login _logout _update _updateEnabledState
command	Device command related actions	_create _delete _start _stop _update
device	Any device in the system	_activateCertificate _command _create _delete _generateCertificate _revokeCertificate _update
device-alert	Device alert related actions	_clear _create _delete _update
generic-entity	Any entity based on the generic entity template	_create _delete _update
organization	Any organization in the system	_create _delete _update _updateAdmin
organization-user	Any user based on the organization-user template	_create _delete _incomingSms _login _logout _update _updateEnabledState
patient	Any user based on the patient template	_create _delete _incomingSms _login _logout _saveMeasurement _saveMeasurementBulk _update _updateEnabledState
patient-alert	Patient alert related actions	_clear _create _delete _update
Registration Code:	Self user registration code	_create _delete _update
usage-session	Regular or remote usage sessions	_create _delete _remotePause _remoteResume _remoteStart _remoteStop _update

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