Webhooks overview
With webhooks, Backlog can be integrated with third-party applications, including chat services such as Typetalk.
Webhooks help send information about Backlog events (e.g. issues added, comments, events shown in the recent updates section of the Dashboard, etc.) as a HTTP POST command to a specified URL (server) in real time.
Did you know?
The specified URL needs to be accessible from Backlog’s server. URLs that are not accessible from Backlog, for e.g. intranet servers and private network IP addresses such as "192.168.x.x" cannot be used.As confidential information like commit messages and email addresses will be sent via the webhook, please use HTTPS URLs to protect your data.
Data format and webhook sender address
Webhook sends data to the specified URL by PUSH in JSON format. Please run tests to check, since aside from some similarities, the JSON data fields differ for each event.
For webhook, the type field will show the same data as the Backlog API response for “Get Recent Updates”.
For the IP addresses where the webhook is sent from, please see the Webhook sender IP address support article.
Add webhook
To add a new webhook, click on Add Webhook at the webhook settings page.
Enter a name for the Webhook, paste the external URL in the Webhook URL field for sending Backlog events data, and select the events to notify.
To send test data, click on the Execute button after choosing the event in the dropdown menu. The sent data and results can be checked in the Webhook sent log.
Click on Add Webhook to submit. The new webhook will be added to the webhook settings page.
Manage webhook settings
In the Backlog project, go to Project Settings > Integrations, and select Webhook > Settings to access the webhook settings page.
A list of existing webhooks, if any, will be shown.
Edit or delete webhook
At the list of existing webhooks, click on Edit next to the webhook.
To edit, edit its contents and click Save. To delete, select Delete.
Webhook Sent Log
The webhook Sent Log shows the list of event data that has been sent with the webhooks and tests in the project.
To view detailed information such as the contents of the sent JSON data, click on Show all.
If the data could not be sent, for e.g. due to an incorrect Webhook URL, a red exclamation mark would be shown under the Failed column.