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

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
usage-session	Regular or remote usage sessions	_create _remoteStart _remoteStop _remotePause _remoteResume _list _update _delete _read
generic-entity	Any entity based on the generic entity template	_create _read _update _list _delete
caregiver	Any user based on the caregiver template	_create _read _update _list _delete _login _logout
patient	Any user based on the patient template	_create _read _update _list _delete _login _logout _saveMeasurement
organization-user	Any user based on the organization-user template	_create _read _update _list _delete _login _logout
organization	Any organization in the system	_create _read _update _list _delete
device	Any device in the system	_create _read _update _list _delete _generateCertificate _revokeCertificate _activateCertificate
command	Device command related actions	_create _update _start _stop _delete
device-alert	Device alert related actions	_create _read _update _list _delete
patient-alert	Patient alert related actions	_create _read _update _list _delete

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