Handling errors
This section provides all the information you need to understand the different types of webhook errors that can occur, how to detect and diagnose them, and most importantly, how to handle them in a way that minimizes downtime and disruption to your workflow.
Retry policy
If Bodyguard.ai fails to send a notification to your configured webhook URL, the retry policy will begin. This system is designed to keep trying to send the notification while your webhook URL is unreachable.
If your webhook URL remains unreachable for an extended period of time, the webhook status will be updated to BROKEN.
In this case, you will need to manually re-enable it through the dashboard.
How it works
If there is an issue with your webhook URL, a warning email will be sent to provide more details. Additional warning emails will be sent if the issue persists.
If the problem is resolved within the retry time interval, a recovery email will be sent to confirm that everything is back to normal.
However, if the problem persists beyond the retry strategy, you will receive a final email notifying you that
your webhook status is now BROKEN (see webhook statuses for more information).
Failure
After the full retry policy time has elapsed, there are two possible use cases:
- At least one notification was successful during the entire retry period:
- You will receive a delivery failure email.
- The webhook will still be
ENABLED, but you should investigate to determine the cause of the failed notification.
- No notifications were sent successfully during the entire retry time:
- You will receive a broken webhook email.
- The webhook status will be set to
BROKEN, and in order to resume receiving notifications, you must fix the issue.
While the status of the webhook remains BROKEN, no more notifications will be sent to it. Therefore, after fixing the issue, remember to log in to the
dashboard and switch the webhook status back to ENABLED in order to resume notifications.
Here are examples of emails that are sent during a retry policy:
Warning email
This email is sent at the first failure, and once in a while during the full retry time.
Recovery email
This email is sent when communication succeeds again after a failure.
Broken webhook email
This email is sent after the full retry time when no notification has ever been sent.
Delivery failure email
This email is sent after the full retry time when a notification has not been successfully sent, even though other notifications have succeeded (the webhook is not set as broken).
