Adding webhooks for Gerrit

Last updated: March 2026

Webhooks are not built into Gerrit by default. You must install and configure the Gerrit webhook plugin before using webhooks with Git Integration for Jira Cloud.

On this page:

• Install the webhook plugin
• Configure webhooks
• Trigger webhooks manually

Install the Webhook Plugin

Install Gerrit with the webhook plugin from https://gerrit.googlesource.com/plugins/webhooks/.

Configure Webhooks

List Projects (Repositories)

curl http(s)://your.org.com:8080/projects/?d

Check Enabled Webhooks

curl http(s)://your.org.com:8080/config/server/webhooks~projects/MyTestRepo/remotes

Add a Webhook

curl --user username:password -H 'Content-Type: application/json' -X PUT -d @webhook.json http(s)://your.org.com:8080/a/config/server/webhooks~projects/MyTestRepo/remotes/bbb-webhook

Create a webhook.json file:

{
   "url" : "https://example.com/webhook/url",
   "maxTries" : 3,
   "sslVerify": true
}

Replace https://example.com/webhook/url with your webhook URL from Git Integration for Jira ➜ Indexing triggers.

Trigger Webhooks Manually

Create a webhook trigger for individual repositories. Use this with continuous integration services.

Required Headers

Optional Headers

Examples

Basic request:

curl -H 'x-bbb-webhook-type: push' -H 'content-type: application/json' -X POST -d @payload.json https://webhook/url

Request with ID:

curl -H 'x-bbb-webhook-type: push' -H 'x-bbb-webhook-id: id-string' -H 'content-type: application/json' -X POST -d @payload.json https://webhook/url

Payload Format

Create a payload.json file:

{  
    "origin": "repository-origin"
}

Replace repository-origin with your repository’s origin URL.