課題が追加または更新されたら(トリガー)
このピースでできることBacklog の接続方法ステップ 1:ホスト名を確認するステップ 2:API キーを発行するステップ 3:workrun に接続を追加するピースの設定項目1. プロジェクト(必須)取得できる情報出力例(抜粋)
このピースでできること
- Backlog の指定したプロジェクトで、課題に動きがあったときにフローを自動で起動します。
- 検知するのは次の3つです。
- 課題の追加
- 課題の更新
- 課題へのコメント
- 進捗の変化を検知して、チャッツールへの通知を自動化できます。
Webhook はフローを有効にすると Backlog 側に自動で登録され、フローを無効にすると自動で削除されます。Backlog の管理画面で手動設定する必要はありません。
Backlog の接続方法
workrun と Backlog を接続するには、Backlog の ホスト名 と API キー が必要です。
ステップ 1:ホスト名を確認する
- Backlog にログインし、ブラウザのアドレスバーを確認します。
- と の間の部分がホスト名です。
- 例: アドレスが の場合、ホスト名は です
- Backlog のドメインには と の2種類があります。自社のスペースのURLに合わせてください
ステップ 2:API キーを発行する
- Backlog の画面右上のプロフィールアイコンから 「個人設定」 を開きます。
- 左メニューの 「API」 を開きます。
- 登録メモに任意の名前を入力し、「登録」 をクリックして API キーを発行します。
- 発行された API キーをコピーしておきます。
API キーは発行したユーザーの権限で動作します。連携したいプロジェクトにアクセスできるユーザーで発行してください。
ステップ 3:workrun に接続を追加する
- workrun で Backlog のアクション/トリガーをフローに追加します。
- 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
- 「ホスト名」 フィールドに、ステップ 1 で確認したホスト名を入力します( は不要です)。
- 「APIキー」 フィールドに、ステップ 2 でコピーした API キーを貼り付けます。
- 「保存」 をクリックして接続を完了します。
Backlog のトリガー(「新しい課題が追加されたら」「課題が追加または更新されたら」)を使う場合、Webhook はフローを有効にすると Backlog 側に自動で登録されます。Backlog の管理画面で手動設定する必要はありません。
ピースの設定項目
1. プロジェクト(必須)
- 監視するプロジェクトを、一覧から選びます。
- 接続を選ぶと自動で一覧が読み込まれます。接続を設定していない場合は「認証情報を入力してください」と表示されます。
- 複数のプロジェクトを監視したい場合は、プロジェクトごとにフローを作成してください。
[設定例]
取得できる情報
Backlogから受信した課題の追加・更新・コメントのイベント情報を、後続ステップで利用できます。主な項目の例は次のとおりです。
| 実際のキー | 内容・条件 |
|---|---|
| 通知されたイベントのID(課題IDとは異なります) | |
| イベント種別 | |
| 対象プロジェクトのID・キー・名称 | |
| 課題ID・課題番号 | |
| 課題の件名・説明 | |
| 状態・担当者の情報。未設定の場合などは空の値になります。 | |
| 操作したユーザーの情報・イベント作成日時 | |
| コメント情報。コメントを含むイベントで利用できます。 | |
| 変更項目や差分。イベント内容に応じて含まれます。 |
- 利用例: でイベントを判別し、課題の件名や変更内容を通知できます。
- イベント種別によって、 内の項目・値は異なります。実際の項目は「テストトリガー」で確認してください。