Remove Webhook Topic Subscription

post/api/webhook-listeners/{listenerId}/unsubscribe

Remove a topic subscription from an existing Webhook Listener.

Request

Path Parameters

listenerIdstringrequired
Id for the Webhook Listener

Body application/json

topicstringrequired
The topic the Webhook Listener will unsubscribe from.

Response

Successful operation.

Body application/json

msgstringrequired
A message indicating the result of removing the subscription.
topicNamestring
The topic to which the webhook listener has been unsubscribed from.
listenerIdstringrequired
The id of the webhook listener associated with this subscription.

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}/unsubscribe' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

curl 'https://api.immersve.com/api/webhook-listeners/{listenerId}/unsubscribe' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

curl 'https://api.immersve.com/api/webhook-listeners/{listenerId}/unsubscribe' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

curl 'https://api.immersve.com/api/webhook-listeners/{listenerId}/unsubscribe' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

curl 'https://test.immersve.com/api/webhook-listeners/{listenerId}/unsubscribe' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

curl 'https://test.immersve.com/api/webhook-listeners/{listenerId}/unsubscribe' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

curl 'https://test.immersve.com/api/webhook-listeners/{listenerId}/unsubscribe' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

curl 'https://test.immersve.com/api/webhook-listeners/{listenerId}/unsubscribe' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "kyc-pending"
}'

Example Response

{
  "msg": "Unsubscribed from topic",
  "topicName": "kyc-pending",
  "listenerId": "51663b110bc97ebc9f9235910c4392c0"
}

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