Webhook

管理者・プロジェクト管理者がWebhookを利用できます。

Webhook機能について説明します。

Webhookとは？

Webhookとは、「課題の追加」や「課題にコメント」などのイベントがプロジェクト中で発生した際に、その情報をリアルタイムに指定されたURL（サーバー）へHTTP POSTする機能です。外部システムとの連携などに利用できます。

Webhookの主要な機能を紹介します。

Webhookの設定一覧を表示する

1. プロジェクト設定 画面に進みます
2. プロジェクト設定 > インテグレーション > Webhook > 設定の順に進みます
3. Webhookの設定一覧画面が表示されます。

この画面でできる操作

この画面でできる操作は次のとおりです。

• Webhookの追加
• Webhookの編集

Webhookを設定を追加する

1. プロジェクト設定 画面に進みます
2. プロジェクト設定 > インテグレーション > Webhook > 設定の順に進みます
3. Webhookの設定一覧画面で「Webhookを追加する」のボタンをクリックします
4. Webhookの追加画面で設定項目を入力し完了します
5. Webhookの設定一覧画面に新しいWebhookの設定が表示されます。

Webhookの設定項目

Webhook URLを設定する

Webhookを受信するサーバーのURLを設定してください。

このURLはインターネットからアクセスできるURLでなければなりません。Backlogのサーバーからアクセスできるようにしておいてください。 イントラネット内のサーバーなど、BacklogからアクセスできないURLは指定できません。

課題の情報やコミットのメッセージが送信されます。これらの情報を保護したい場合には、HTTPSのURLをご指定ください。

通知イベントを設定する

「課題の追加」など、WebhookのトリガーとなるBacklogの操作にチェックを入れてください。

Webhookの実行テストを行う

実行テストの項目では、送信するイベントの種別を選んで実行ボタンをクリックすることで実際にテストデータを送信できます。

テスト送信の内容や結果は送信履歴の一覧で確認できます。

Webhookの設定を編集する

1. プロジェクト設定 画面に進みます
2. プロジェクト設定 > インテグレーション > Webhook > 設定の順に進みます
3. Webhookの設定一覧画面にあるWebhookの設定の「編集」のボタンをクリックします
4. Webhookの編集画面の設定項目を入力し完了します

Webhookの設定を削除する

1. プロジェクト設定 画面に進みます
2. プロジェクト設定 > インテグレーション > Webhook > 設定の順に進みます
3. Webhookの設定一覧画面にあるWebhookの設定の「編集」のボタンをクリックします
4. Webhookの編集画面にある「削除」ボタンをクリックします
5. Webhookの設定一覧画面からWebhookの設定が削除されます。

Webhookの送信履歴を確認する

1. プロジェクト設定 画面に進みます
2. プロジェクト設定 > インテグレーション > Webhook > 設定の順に進みます
3. 「送信履歴」のタブを開きます
4. Webhookの送信履歴の画面が表示されます

お困りの場合は…

WebhookのJSONの形式を教えてください。

Webhookでは、指定されたURLにデータをJSON形式でPOSTします。JSONデータの属性は一部の共通部分を除き、イベントによって異なるためテスト実行等で確認してください。

typeの値は何を設定すればいいですか？

type属性の値には Backlog API「最近の更新の取得」 で得られるデータと同じ内容を表します。