Biot Notification Plugins

BioT notification plugins will be called when certain actions are completed successfully. BioT will not be 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

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