Optional Set-Up Tasks

You can complete optional set-up tasks during or after creating a webhook subscription. These tasks are optional and are not required to successfully set-up webhook subscriptions.

• Include a health check URL to enable to monitor your server's status for reliability.
• Validate the integrity of a webhook notification.
• Set up a retry policy for how to receive notifications when your server URL is initially unresponsive.

Health Check URL

When you create a webhook subscription, recommends that you include a health check URL in the request. Including a health check URL enables to monitor your server's status for reliability. When detects that your health check URL is unresponsive, notification deliveries are withheld until your health check URL becomes responsive again. A health check URL ensures that you do not miss any notifications.

To add a health check URL to your create a subscription request, include the healthCheckurl field and set it to your health check URL. You must also include the deactivateflag field and set it to true to enable to withhold notifications for periods when your server becomes unresponsive.

Automatic Activation

After you successfully create or update a subscription, pings your health check URL within five to ten minutes. If receives a response, the subscription status automatically becomes ACTIVE and notifications are delivered. When does not receive a response, your subscription status remains SUSPENDED until receives a response. If you did not include a health check URL when you created the subscription, pings your webhook URL for automatic activation instead. You can also activate a subscription that is not automatically activated by sending a PUT request.

Automatic Revalidation

After the subscription's initial activation, continues to monitor your server status. If detects that your server is unavailable, your subscription status automatically updates to SUSPENDED, and notifications are withheld. When detects that your server is available again, your subscription status automatically updates to ACTIVE, and all withheld notifications are delivered.

Retry Policy

If your webhook URL or health check URL are unresponsive, resends the webhook notifications according to the subscription's retry policy. All subscriptions have a default retry policy (see the default values in the field descriptions below). You can change the retry policy when you create a subscription or update the webhook subscription by modifying the retry field values described below.

To configure a subscription's retry policy, include these required fields in the create a subscription request or an update a subscription request:

Example

This example shows how to format a retry policy in a request.

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