Get Webhook Listener

get/api/webhook-listeners/{listenerId}

Retrieves a specific Webhook Listener for the given id.

Request

Path Parameters

listenerIdstringrequired
Id for the Webhook Listener

Response

Successful operation.

Body application/json

idstringrequired
Webhook Listener primary identifier.
accountIdstringrequired
Partner Account id.
urlstringrequired
The URL to send webhook notifications to.
createdAtstringrequired
Timestamp of Webhook Listener creation.
statusstringrequired
Allowed values:activeinactive
Status of the Webhook Listener.
topicSubscriptionsstring[]required
List of topics the webhook listener is subscribed to.

No Authorization to access resource.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

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

Example Response

{
  "id": "315bad4e81ce0f26966a41b9d451638b",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks",
  "createdAt": "2023-08-14T12:32:54",
  "status": "active",
  "topicSubscriptions": [
    "kyc-pending",
    "payment-3ds-otp"
  ]
}

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