Git Webhook is used to send information to other applications or servers via HTTP POST to their URL address, when the Backlog's Git repository experiences a git push.
Git webhook can be used for the following purposes:
- to trigger a Continuous Integration (CI) build
- to update a backup
- to apply the newest version to the staging area
- to connect to other external systems
These operations can also be done using the CI server's polling or cron functions which will regularly poll the Git repository. But the disadvantage of polling is it only accesses the repository periodically and updates could be missed due to the time lag between polling and the latest push.
With webhooks, the sending of information via HTTP POST is performed immediately as it happens. Therefore, there is no time lag.
Git webhook settings
Webhooks can be set up for each repository. Go to Project Settings > Git Settings to access the individual repository’s settings and enter the webhook URL.
For more information on Git settings, see Manage Git settings support article.
Did you know?Please make sure that the specified URL for the Webhook is accessible from Backlog server. Private server URLs, such as the ones located in an intranet, cannot be accessed from Backlog. Similarly, private network IP addresses, such as "192.168.x.x", cannot be specified.
To fix the temporary error at the webhook receiving server (when you get HTTP status code 5xx after POST), please try again several times.
Information, such as the commit and author’s email address will be sent as described below under “Webhook data format”. To secure the information sent during transmission, please specify a HTTPS URL.
Webhook data format
The information sent to the specified webhook URL is in JSON format.
The payload parameters are:
Example of the JSON data: