BioT Interceptor Plugins

BioT Interceptor plugins are lambda code that is called before or after an API call and lets the plugin modify the call request or response accordingly. The plugins are useful when you want to modify an API request before it is processed by BioT or modify the response before it arrives to the UI.

Flow Example

720

Subscribing to Events

To subscribe to an API, call the subscribe API of the service:
POST https://your-biot-domain.com/dispatcher/v1/hooks/interceptions/subscribe

ParameterDescriptionFormat
typeThe type of interception. Meaning pre, post or entity interception.Values:PRE_REQUEST,POST_REQUEST,ADAPT_ENTITY
apiIdThe API to intercept. The signature of the API made of the request type and URL signature.Example: PATCH/organization/v1/users/patients/{id}
entityNameShould be provided only in ADAPT_ENTITY mode.usage-session
generic-entity
caregiver
patient
organization-user
organization
device
command
device-alert
patient-alert
endpointA valid URI for the platform to call when the event is triggered.
Mandatory.
https://my-web-hook.com
executionOrderOptional parameter to determine the plugin execution order if multiple interceptors exists for the same API

Interceptor Plugin Deployment

For detailed instructions on how to deploy an interceptor plugin click here.