On This Page

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 Webhook Health Check and Automatic Revalidation.
The retry fields are described below.
deactivateFlag
If the
deactivateFlag
 field is set to
false
 and all retry attempts fail, the subscription status changes to
SUSPENDED
 and the status of the notifications changes to
FAILED
.
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.

Example: Retry Policy in a Subscription Request

  "retryPolicy": {
    "firstRetry": "1",
    "interval": "1",
    "numberOfRetries": "3",
    "deactivateFlag": "false",
    "repeatSequenceCount": "0",
    "repeatSequenceWaitTime": "0"
  }