Subscribe for intercepting APIs

Subscribe for intercepting APIs

Multiple subscriptions with different endpoints is allowed for the same type and apiId.
Multiple subscriptions with different endpoints of type ADAPT_ENTITY is allowed for the entityName.
If a subscription already exists, it will be overridden with the new executionOrder (if provided in the request).
If an interception is created or updated to have the same executionOrder as an existing interception (including existing ones with default executionOrder),
It will be set with that executionOrder and the existing interception's executionOrder will be incremented.
If that interception's new executionOrder clashes with another the other one will be incremented as well, and so forth.

The below table describes the request parameters:

ParameterTypeMandatoryDescription
typeStringtrueSupported values are: PRE_REQUEST, POST_REQUEST, ADAPT_ENTITY
apiIdStringfalseShould only be provided if type=PRE_REQUEST or type=POST_REQUEST. Supported api ids are:
DELETE/organization/v1/users/patients/{patientId}/alerts/{id}
PATCH/organization/v1/users/patients/{id}
DELETE/organization/v1/users/patients/{id}
GET/organization/v1/organizations
GET/organization/v1/users/patients
GET/organization/v1/users/organizations
PATCH/organization/v1/users/organizations/{id}
PATCH/organization/v1/users/caregivers/{id}
GET/organization/v1/users/organizations/self
POST/organization/v1/users/patients
GET/organization/v1/users/caregivers
GET/organization/v1/users/patients/current/alerts
GET/organization/v1/users/caregivers/{id}
POST/organization/v1/users/organizations
POST/organization/v1/users/patients/{id}/enabled-state/{state}
POST/organization/v1/users/patients/{patientId}/alerts/{templateName}
GET/organization/system/healthCheck
POST/organization/v1/invitations/{userId}
GET/organization/v1/users/patients/{id}
DELETE/organization/v1/users/caregivers/{id}
POST/organization/v1/organizations
DELETE/organization/v1/organizations/{id}
POST/organization/v1/users/organizations/{id}/enabled-state/{state}
POST/organization/v1/organizations/first
PATCH/organization/v1/organizations/{id}
POST/organization/v1/users/patients/{patientId}/alerts
POST/organization/v1/users/caregivers/{id}/enabled-state/{state}
POST/organization/v1/users/caregivers
GET/organization/v1/users/self
POST/organization/v1/organizations/admin/{newAdminId}
GET/organization/v1/users/organizations/{id}
DELETE/organization/v1/users/organizations/{id}
PATCH/organization/v1/users/patients/{patientId}/alerts/{id}
GET/organization/v1/users/patients/{patientId}/alerts/{id}
GET/organization/v1/organizations/{id}
GET/organization/v1/users/patients/alerts
GET/organization/v1/users/patients/self
GET/organization/v1/users/caregivers/self
entityNameStringfalseShould only be provided if type=ADAPT_ENTITY. Supported entity names are:
caregiver
patient
organization
organization-user
patient-alert
endpointStringtrueA valid URI
executionOrderIntegerfalseIf not provided, the default value will be taken from the environment variable: EXECUTIONORDER_DEFAULT, Multiple subscription with the same executionOrder is allowed

This API requires HOOKS_INTERCEPTION_CREATE permission(s).

Language
Authentication
Bearer
JWT
Click Try It! to start a request and see the response here!