Webhooks allow Backlog to be integrated with third-party applications, sending real-time information about events (e.g., new issues, comments, etc.) by PUSH in JSON format to a specified URL (server).
In this guide, we’ll show you how to:
- Add webhooks
- Manage webhooks
- Review the sent log
Add webhooks
To add a webhook:
- Go to project settings.
- Select “Integrations” from the menu on the left.
- Select “Settings” next to webhook.
- Select “Add webhook.”
- Enter the information.
- Select “Execute” to send test data.
- Select “Add webhook.”
- Check the test results in the sent log.
The webhook type is the same as the Backlog API response for “Get recent updates.”
If your receiving server limits incoming requests by IP address, allow the addresses below (subject to change). You can also add BASIC authentication to the webhook URL that doesn’t depend on the IP address.
| Sender IP addresses | |
| Webhook |
|
| Git webhook |
|
The webhook URL needs to be accessible from Backlog’s server and should be an HTTPS URL to protect confidential information. Intranet servers and private network IP addresses (e.g., 192.168.x.x) can’t be used.
Manage webhooks
To edit or delete a webhook:
- Go to project settings.
- Select “Integrations” from the menu on the left.
- Select “Settings” next to webhook.
- Select “edit” or “delete” next to the specific webhook you want to manage.
Review the sent log
The sent log lists the event data sent with webhooks and any tests executed during setup. To access the sent log:
- Go to project settings.
- Select “Integrations” from the menu on the left.
- Select “Settings” next to webhook.
- Select the “Sent log” tab.
- Select “Show all” to see details about a specific webhook.
