Create Webhook Subscription

This section describes how to create a webhook subscription.
IMPORTANT
You must set the
organizationId
 field value to that of the
TMS
 vault owner. To receive life-cycle management notifications for network tokens that are created by transacting merchant IDs (MIDs) under that
TMS
 vault, you must set the scope of the field value to
descendants
.

Endpoint

Test:
POST
https://apitest.cybersource.com
/notification-subscriptions/v1/webhooks
Production:
POST
https://api.cybersource.com
/notification-subscriptions/v1/webhooks
Production in India:
POST
https://api.in.cybersource.com
/notification-subscriptions/v1/webhooks

Required Fields for Creating Webhook Subscription

clientRequestAction
keyInformation.provider
keyInformation.tenant
The value must be set to
nrtd
.
keyInformation.keyType
keyInformation.organizationId
keyInformation.expiryDuration

REST Example: Creating a Webhook Subscription

Light Dark
Request
12345678910111213141516171819202122232425262728
{"organization": {"organizationId": "TMSVaultOwnerOrgID"},
   "product": {"productId": "tokenManagement"},
   "webhook":    {
      "webhookId": "e33b4ff7-f94a-2de4-e053-a2588e0a0403",
      "webhookUrl": "https://URL",
      "createdOn": "2021-12-15 23:46:00.053",
      "eventTypes":       [
         {"name": "tms.networktoken.binding"},
         {"name": "tms.networktoken.provisioned"},
         {"name": "tms.networktoken.updated"}
      ],
      "status": "ACTIVE",
      "retryPolicy":       {
         "algorithm": "ARITHMETIC",
         "firstRetry": 5,
         "interval": 5,
         "numberOfRetries": 4,
         "deactivateFlag": false,
         "repeatSequenceCount": 4,
         "repeatSequenceWaitTime": 5
      },
      "securityPolicy": [      {
         "digitalSignatureEnabled": "yes",
         "proxyType": "external",
         "security_id": "c05cc30a-ce9b-487f-be38-65ab5977b5bc",
         "security_type": "key"
      }]
   }}
Response to a Successful Request
1234567891011121314151617181920212223242526272829
{"organizationId": "TMSVaultOwnerOrgID",
  "productId": "terminalManagement",
  "eventTypes": [
    "tms.networktoken.binding",
    "tms.networktoken.provisioned",
    "tms.networktoken.updated"
  ],
  "webhookId": "e33b4ff7-f94a-2de4-e053-a2588e0a0403",
  "webhookUrl": "https://NewURL",
  "healthCheckUrl": "https://URL",
  "createdOn": "2022-07-07 17:24:05.116",
  "status": "ACTIVE",
  "retryPolicy": {
    "algorithm": "ARITHMETIC",
    "firstRetry": 1,
    "interval": 1,
    "numberOfRetries": 3,
    "deactivateFlag": false,
    "repeatSequenceCount": 0,
    "repeatSequenceWaitTime": 0
  },
  "securityPolicy": {
    "securityType": "KEY",
    "proxyType": "external",
    "digitalSignatureEnabled": "yes"
  },
  "version": "3",
  "deliveryType": "nrtdCentral",
  "notificationScope": "DESCENDANTS"}