Skip to main content

Handling failed webhook deliveries

A webhook delivery can fail for multiple reasons. For example, if your server is down or takes longer than 10 seconds to respond, will record the delivery as a failure.

does not automatically redeliver failed deliveries.

You can manually redeliver failed deliveries. For more information, see Redelivering webhooks.

You can also write a script that checks for failed deliveries and attempts to redeliver any that failed. Your script should run on a schedule and do the following:

  1. Use the REST API to fetch data about any webhook deliveries that were attempted since the last time that your script ran. For more information, see REST API endpoints for repository webhooks, REST API endpoints for organization webhooks, and REST API endpoints for App webhooks.

    There are no API endpoints to get data about Marketplace webhooks, Sponsors webhooks, or global webhooks.

  2. Look at the fetched data to see if any deliveries failed. The data for a failed delivery will have a status value that is not OK.

  3. Use the REST API to redeliver any deliveries that failed. For more information, see REST API endpoints for repository webhooks, REST API endpoints for organization webhooks, and REST API endpoints for App webhooks.

For example scripts, see:

If a webhook delivery fails repeatedly, you should investigate the cause. Each failed delivery will give a reason for failure. For more information, see Troubleshooting webhooks.