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:
GET/device/v1/devices/{deviceId}/commands/{id}
POST/device/v1/devices/{deviceId}/usage-sessions/remote-control/start
POST/device/v2/devices/{id}/certificate/activate
GET/device/v2/credentials/organization
POST/device/v1/devices/{deviceId}/usage-sessions/{id}/remote-control/pause
GET/device/v2/devices/{id}/connection/details
POST/device/v1/devices/{deviceId}/commands/start
GET/device/v1/devices/usage-sessions
POST/device/v1/devices/{deviceId}/commands/{templateName}/start
GET/device/v2/devices
GET/device/system/healthCheck
DELETE/device/v1/devices/{deviceId}/alerts/{id}
GET/device/v1/devices/{deviceId}/usage-sessions/{id}
GET/device/v1/devices/{deviceId}/alerts/{id}
DELETE/device/v2/devices/{id}/certificate
GET/device/v1/devices/current/alerts
POST/device/v1/devices/{deviceId}/usage-sessions/usage-type/{usageType}
POST/device/v2/devices
DELETE/device/v1/devices/{deviceId}/usage-sessions/{id}
POST/device/v1/devices/{deviceId}/usage-sessions/{id}/remote-control/stop
GET/device/v2/credentials
PATCH/device/v1/devices/{deviceId}/alerts/{id}
GET/device/v1/devices/commands
POST/device/v1/devices/{deviceId}/alerts
DELETE/device/v1/devices/{deviceId}/commands/{id}
DELETE/device/v2/devices/{id}
PATCH/device/v2/devices/{id}
POST/device/v1/devices/{deviceId}/alerts/{templateName}
PATCH/device/v1/devices/{deviceId}/usage-sessions/{id}
GET/device/v1/devices/current/usage-sessions
GET/device/v2/devices/{id}/mqtt-credentials
POST/device/v2/devices/{id}/certificate
POST/device/v1/devices/{deviceId}/commands/{id}/stop
GET/device/v2/devices/{id}
POST/device/v1/devices/{deviceId}/usage-sessions/{id}/remote-control/resume
GET/device/v1/endpoint
GET/device/v1/devices/alerts
POST/device/v1/devices/{deviceId}/usage-sessions
entityNameStringfalseShould only be provided if type=ADAPT_ENTITY. Supported entity names are:
usage-session
device-alert
device
command
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!