Transactional Test

post{listenerUrl}/transactional-test

This webhook notification is triggered in response to a successful call to the Send Webhook Test Notification endpoint when the topic parameter in the request body is set to transactional-test.
It is designed to test the transactional flow for the integration and serves as confirmation of its successful setup.

Request

Header Parameters

X-Delivery-Idstring
Unique message id plus delivery attempt.
X-Key-Idstring
ID of the public key used to validate the signature.
X-Signaturestring
Base64-encoded RSA SHA-256 signature of {deliveryId}:{keyId}:{requestBody}.

Body application/json

topicstring
Allowed values:transactional-test
payloadobject
- msgstring
  Allowed values:Test transactional topic
messageIdstring
listenerIdstring
listenerAccountIdstring
deliveryAttemptnumber
createdAtstring
The notification message creation timestamp.
sentAtstring
The delivery attempt timestamp.
keyIdstring
The public key id for validating the signature. Public keys can be found at https://api.immersve.com/.well-known/jwks.json and matched using the "kid" attribute.
issuerstring

Example

Example Request

{
  "topic": "transactional-test",
  "payload": {
    "msg": "Test transactional topic"
  },
  "messageId": "msg-1234",
  "listenerId": "listener-1234",
  "listenerAccountId": "partner-account-1",
  "deliveryAttempt": 1,
  "createdAt": "2025-09-29T10:11:12Z",
  "sentAt": "2025-09-29T10:11:13Z",
  "keyId": "9ce69d31277108d46d2cb19fa772705e",
  "issuer": "api.immersve.com"
}