Optional Tasks

This section describes optional tasks that can be completed after subscription.

Figure:

Optional Tasks

Notification Validation

Webhook notifications are sent with a digital signature that you can use to validate the integrity of the notification and prevent replay attacks. You must first generate a digital signature key. See the Requesting a Digital Signature Key topic for the applicable Webhooks subscription workflow.

Retry Policy

If the webhook URL or health check URL are unresponsive, the notifications will be resent based on the retry policy. The retry policy is set in the
retryPolicy
object of the subscription. You can set the retry policy when you POST the subscription request or modify it later using a PATCH request. For more information about the health check URL, see the Health Check URL topic for the applicable Webhooks subscription workflow.
The retry fields are described below.
deactivateFlag
If the
deactivateFlag
field is set to
false
and all retry attempts fail, the subscription statusjava.io.PrintWriter@ee51d0c changes to
SUSPENDED
and the status of the notifications changes to
FAILED
. Customer support is notified and contacts you.
If the
deactivateFlag
field is set to
true
, notifications are held in a message queue and the status of the notifications is changed to
SUSPENDED
. When the health check URL becomes responsive, the subscription status changes to
ACTIVE
.
firstRetry
Number of minutes before the notification is resent. The default value is
1
.
interval
Number of minutes between each retry. The default value is
1
.
numberOfRetries
Number of times to retry. The default value is
3
.
repeatSequenceCount
Number of times to repeat the retry sequence.
repeatSequenceWaitTime
Number of minutes between each repeat sequence.

Testing API Requests

It is strongly recommended that you test your Webhooks API integration. Our testing URL is:
Testing:
https://apitest.cybersource.com
We offer two methods:
  • Live Console
  • Postman

Live Console

You can use the Reference Guide Live Console to test Webhook API requests and receive responses.
You can use your own test account by adding the account credentials in the Sandbox Configuration section of the Configuration tab. You can also use a generic test account by using the Organization ID
testrest
.
Select a request type in the left-navigation column. For example, Create a Webhook. You can use the Request Builder to add and remove fields or choose a type of API request from the
Configuration > Sample Request
drop-down menu. For example, if you choose the
Configuration > Sample Request
drop-down menu and select
Create Invoicing Webhook
, the body of the request uses invoicing fields.

Figure:

Reference Guide Live Console

Postman

If you would like to use Postman for testing, contact your account manager for a webhooks Postman collection.