Create Webhook Listener

post/api/webhook-listeners

Create a webhook listener to receive notifications for subscribed topics. Add Webhook Topic Subscription endpoint must be used to subscribe to one or more topics.

Request

Body application/json

accountIdstringrequired
The id of the partner account to add this Webhook Listener to.
urlstringrequired
The URL to send webhook notifications to.

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.

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 \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

curl https://api.immersve.com/api/webhook-listeners \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

curl https://api.immersve.com/api/webhook-listeners \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

curl https://api.immersve.com/api/webhook-listeners \
  --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 '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

curl https://test.immersve.com/api/webhook-listeners \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

curl https://test.immersve.com/api/webhook-listeners \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

curl https://test.immersve.com/api/webhook-listeners \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

curl https://test.immersve.com/api/webhook-listeners \
  --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 '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks"
}'

Example Response

{
  "id": "315bad4e81ce0f26966a41b9d451638b",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "url": "https://example.com/webhooks",
  "createdAt": "2023-08-14T12:32:54",
  "status": "active"
}

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