Configure the Retry Policy
If your webhook URL or health check URL are unresponsive,
Cybersource
resends
the webhook notifications according to the subscription's retry policy
. All
subscriptions are created with a default retry policy. You can configure the default
retry policy when you create a subscription or update the webhook subscription.To configure a subscription's retry policy, include these required fields in the
create a
subscription
request or an update a subscription
request: - retryPolicy.deactivateFlag
- Set to one of these possible values:
- false: Notifications arenotwithheld when your webhook URL or health check URL are unresponsive. This is the default value.
- true: Notifications are withheld when your webhook URL or health check URL are unresponsive, and the subscription status updates toSUSPENDED. When the URLs become responsive again, the withheld notifications are sent and the subscription status updates toACTIVE.
- retryPolicy.firstRetry
- The number of minutes before the notification is resent. The default value is1.
- retryPolicy.interval
- The number of minutes between each retry attempt. The default value is1.
- retryPolicy.numberOfRetries
- The number of retry attempts. The default value is3.
- retryPolicy.repeatSequenceCount
- The number of times to repeat the retry sequence. The default value is0.
- retryPolicy.repeatSequenceWaitTime
- The number of minutes between each repeat sequence. The default value is0.
Example: Retry Policy in a Subscription Request
This excerpt example shows how to format a retry policy in a request.
"retryPolicy": { "firstRetry": "1", "interval": "1", "numberOfRetries": "3", "deactivateFlag": "false", "repeatSequenceCount": "0", "repeatSequenceWaitTime": "0"}