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.
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

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