Skip to content

Webhook notifications#

Webhook notifications enable Codacy to integrate with a service by sending a POST message to a custom address after analyzing each commit belonging to an active branch. You can set up multiple webhook notifications per repository.

Adding a webhook notification#

To add a webhook notification:

  1. Open your repository Settings, tab Integrations, and click the button Add integration to open a modal window listing integration options.

  2. Click Webhook and scroll to the bottom of the page to access the newly created Webhook settings panel.

    Adding a webhook

  3. Fill in the field with the address of your endpoint and click Save.

    To send a sample payload to the specified endpoint, click the Test button.

    Adding a webhook

Payload format#

Each webhook notification includes a JSON payload with the following fields:

{
  "commit": {
    "data": {
      "uuid": "4cbf02df84dbcaa44b75a64ed832f7dbff2231dd",
      "urls": {
        "delta": "https://www.codacy.com/public/jquery/jquery.git/commit?bid=21776&cid=6037089"
      }
    },
    "results": {
      "fixed_count": 1,
      "new_count": 0
    }
  }
}

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

Edit this page on GitHub if you notice something wrong or missing.

If you have a question or need help please contact support@codacy.com.

Last modified February 21, 2023