How to view your GitHub webhook deliveries

GitHub Webhooks

Viewing webhooks on GitHub can be a useful diagnostic tool when attempting to discover why perhaps a push to your repo has potentially not resulted in a job on CircleCI.

What is a webhook?

A webhook is what allows CircleCI to automatically take action every time you push a commit. GitHub will send us a packet of information about your project when a number of events occur, a "push" being the most popular.

GitHub developer docs | Webhooks

How to find your webhooks

  1. Navigate to your repository's settings page.
  2. Select "Webhooks" in the left menu. (Alternatively, you can reach this page directly -> https://github.com/<ORGANIZATION>/<REPOSITORY>/settings/hooks)
  3. You should now see a page similar to the following:

    GH_repo_settings.png

  4. From here, click on the CircleCI webhook URL; this will take you to the "Webhooks / Manage webhook" page. On that page, select the "Recent Deliveries" tab. You will also see the type of event next to the entry.

    Screenshot 2024-02-22 at 16.21.37.png
    Screenshot_2023-05-10_at_10.50.12.png

  5. Click on any entry to view the delivery details. This will show the Headers and Payload of the webhook.

    Screenshot_2023-05-10_at_10.52.46.png

The X-GitHub-Delivery value (which is the same as the id you clicked on to open this delivery) is useful for tracking your webhook. Support can use this to do further investigation if needed.

In the Payload section under the SHA value, you can find the commit hash to ensure the webhook is referring to the correct commit.

You can also check the response back from CircleCI when GitHub sent the response. Switch from the "Request" tab to the "Response" tab. If you see a "200" response, your WebHook was delivered successfully.

Screen_Shot_2019-04-11_at_5.31.21_PM.png

Additional Resources

Was this article helpful?
30 out of 65 found this helpful

Comments

0 comments

Article is closed for comments.