On This Page

Verify a Webhook Subscription's Configuration

This section describes how to test if a webhook subscription is configured correctly. Use this request to verify that the details you are expecting in the webhook notification are included, such as the notification message and the product and event types.

A successful response includes the expected notification message and the product and event type. Only the first event type in your subscription is listed in the

eventType

response field.

This request requires the webhook subscription ID. The subscription ID is in the

webhookId

response field from the create a webhook subscription
request.

Endpoints

Send a POST request to one of these endpoints. The {webhookId}
is the webhook subscription ID.

IMPORTANT

This endpoint uses the

/v1/

path segment.

Test:

POST apitest.cybersource.com/notification-subscriptions/v1/webhooks/{webhookId}

Production:

POST api.cybersource.com/notification-subscriptions/v1/webhooks/{webhookId}

India Production:

POST https://api.in.cybersource.com/notification-subscriptions/v1/webhooks/{webhookId}

Example: Verifying a Webhook Subscription's Configuration

Request

POST https://apitest.cybersource.com/notification-subscriptions/v1/webhooks/17915c64-73d9-5475-e063-7cb8d30a8089

Response to a Successful Request

{
   "eventDate": "2024-05-08T16:15:23",
    "eventType": "tms.networktoken.updated",
    "organizationId": "npr_gpn",
    "payloads": {
        "testPayload": {
            "message": "Yay! Your webhook integration worked! This is only a test and an example of what a webhook message payload looks like. Thank you for using our test feature."
        }
    },
    "productId": "tokenManagement",
    "requestType": "NEW",
    "retryNumber": "0",
    "transactionTraceId": "ddd8883c-f14d-48af-bd35-ff9b4a51ca35",
    "webhookId": "17915c64-73d9-5475-e063-7cb8d30a8089"
}

Response Codes

A successful request is indicated by the 200-level response code.

For more information about all of the possible response codes you can receive, see

Transaction Response Codes

REST Interactive Example: Verifying a Webhook Subscription's Configuration

Click this image to access the interactive code example for testing a webhook subscription configuration.

Image and link to the interactive code example for testing a
webhook subscription configuration. — Testing a Webhook Subscription Configuration

Verify a Webhook Subscription's Configuration

Endpoints

Example: Verifying a Webhook Subscription's Configuration

Response Codes

REST Interactive Example: Verifying a Webhook Subscription's Configuration

Figure: