Skip to content
This documentation applies to Codacy Self-hosted v3.5.1

For the latest updates and improvements, see the latest Cloud documentation instead.

Webhook notifications

Codacy integrates with any service by sending a POST message to a defined address.

To add a webhook, access the Integrations tab of your repository Settings, click on Add channel and select Webhook from the list.

Adding a webhook

Configuration

Endpoint Address

The URL where to POST the message.

After filling the field you have to click the Save button and everything should be setup correctly. You can use the Test button to send a test notification to the address.

When Codacy sends the POST to the address the message is in JSON format. Below, you can see an example message:

{
  "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.

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

Last modified November 17, 2020