Send Webhook Test Notification

post/api/webhook-test-notifications

Fire a sample notification to check that one or multiple webhook listeners are correctly set up for a particular topic and account. Test notification can be targeted to a specific listener by providing listenerId body parameter.

Request

Body application/json

topicstringrequired
The subject area the listener is subscribed to, see Webhook Topics
accountIdstringrequired
The identifier for the partner account associated with the listener.
listenerIdstring
Optional. If provided the test notification will be sent only to that specific, subscribed listener. If omitted the notification will be sent to every active subscribed listener for the given topic.

Response

Successful operation.

Body application/json

notificationsobject[]
Items
- idstringrequired
  The id of the notification sent.

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-test-notifications \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "topic": "async-test",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "listenerId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

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

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

curl https://api.immersve.com/api/webhook-test-notifications \
  --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": "async-test",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "listenerId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

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

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

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

curl https://test.immersve.com/api/webhook-test-notifications \
  --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": "async-test",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "listenerId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

Example Response

{
  "notifications": [
    {
      "id": "r7i48f309cfc11f0873s"
    }
  ]
}

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