Delete Webhook Listener

delete/api/webhook-listeners/{listenerId}

Delete an existing Webhook Listener.

Request

Path Parameters

listenerIdstringrequired
Id for the Webhook Listener

Response

Successful operation.

Body application/json

msgstringrequired
A message indicating the result of deleting the webhook listener.
idstringrequired
The id of the webhook listener that was deleted.

User is not allowed to perform the action with the reason stated in the errorCode.

FORBIDDEN Insufficient permissions to perform the action.

ACCOUNT_TYPE_INVALID accountType of the accountId is not of type PARTNER.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/webhook-listeners/{listenerId}' \
  --request DELETE \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/webhook-listeners/{listenerId}' \
  --request DELETE \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

curl 'https://test.immersve.com/api/webhook-listeners/{listenerId}' \
  --request DELETE \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

Example Response

{
  "msg": "Listener deleted",
  "id": "51663b110bc97ebc9f9235910c4392c0"
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}