Add Webhook Topic Subscription

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

Add a topic subscription to an existing webhook listener.

Request

Path Parameters

listenerIdstringrequired
Id for the Webhook Listener

Body application/json

topicstringrequired
The topic the Webhook Listener will subscribe to.

Response

Successful operation.

Body application/json

idstringrequired
The unique identifier for the topic subscription.
topicstringrequired
The topic to which the webhook listener is subscribed.
listenerIdstringrequired
The id of the webhook listener associated with this subscription.
accountIdstringrequired
The id of the partner account associated with this subscription.
createdAtstringrequired
The timestamp when the topic subscription was created.

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}/subscribe' \
  --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}/subscribe' \
  --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}/subscribe' \
  --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}/subscribe' \
  --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}/subscribe' \
  --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}/subscribe' \
  --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}/subscribe' \
  --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}/subscribe' \
  --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

{
  "id": "2f251c48a12797c24a36af52fb642895",
  "topic": "kyc-pending",
  "listenerId": "51663b110bc97ebc9f9235910c4392c0",
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "createdAt": "2023-10-01T12:34:56Z"
}

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