On This Page

Webhook Health Check URL and Automatic Revalidation

When you create a webhook subscription, Barclays recommends that you include a health check URL in the request. Including a health check URL enables Barclays to monitor your server's status for reliability. When Barclays 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 Barclays to withhold notifications for periods when your server becomes unresponsive.

Automatic Activation

After you successfully create or update a subscription, Barclays pings your health check URL within five to ten minutes. If Barclays receives a response, the subscription status automatically becomes

ACTIVE

and notifications are delivered. When Barclays does not receive a response, your subscription status remains

SUSPENDED

until Barclays receives a response. If you did not include a health check URL when you created the subscription, Barclays pings your webhook URL for automatic activation instead. You can also activate a subscription that is not automatically activated by sending a PUT request. For more information, see Activate a Webhook Subscription.

Automatic Revalidation

After the subscription's initial activation, Barclays continues to monitor your server status. If Barclays detects that your server is unavailable, your subscription status automatically updates to

SUSPENDED

, and notifications are withheld. When Barclays detects that your server is available again, your subscription status automatically updates to

ACTIVE

, and all withheld notifications are delivered.