Git Webhook

Git Webhook is a feature used to HTTP POST to the specified URL (server) when the local repository is pushed to the Backlog's Git repository.

 Git Webhook

Git Webhook

For example, 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 staging area

to connect other external systems

These can be done by using CI server's polling or cron features, which will access the Git repository regularly. In contrast with polling, which accesses the repository periodically and could cause a time lag between operation and push, Webhook will HTTP POST right after the push. Therefore the operation can be done immediately without any time lag.

 

Setting Webhooks

Webhooks can be set for each repository.

Please refer the following pages to specify the URL to POST:

 

Create Git repository

Edit Git repository

Note

 

Please make sure that the specified URL for the Webhook is accessible from Backlog server. Server URLs, such as the ones located in the intranet, that cannot be accessed from Backlog cannot be chosen. Similarly, private network IP addresses, such as "192.168.x.x", cannot be specified.

To fix the temporal Webhook receiver server's error (when you get HTTP status code 5xx after POST), please try again several times.

Information, such as commit and the email address, will be sent as described below. To protect this information, please specify the HTTPS URL.

 

Data format

With Webhook, pushing data sends the information to a specified URL in the JSON format. “Payload” is the only parameter of JSON data as shown below:

Screen_Shot_2018-03-26_at_3.18.08_PM.png

 Sample data:

Screen_Shot_2018-03-26_at_3.18.24_PM.png