課題の状態を更新する

このピースでできること

  • Backlog の課題の状態(未対応・処理中・完了など)を更新します。
  • 完了にする場合は完了理由も指定でき、同時にコメントを残せます。
  • 外部システムの完了イベントを受けて、Backlog 側のステータスを自動で同期できます。

Backlog の接続方法

workrun と Backlog を接続するには、Backlog の ホスト名API キー が必要です。

ステップ 1:ホスト名を確認する

  1. Backlog にログインし、ブラウザのアドレスバーを確認します。
  1. の間の部分がホスト名です。
      • 例: アドレスが の場合、ホスト名は です
      • Backlog のドメインには の2種類があります。自社のスペースのURLに合わせてください

ステップ 2:API キーを発行する

  1. Backlog の画面右上のプロフィールアイコンから 「個人設定」 を開きます。
  1. 左メニューの 「API」 を開きます。
  1. 登録メモに任意の名前を入力し、「登録」 をクリックして API キーを発行します。
  1. 発行された API キーをコピーしておきます。
⚠️
API キーは発行したユーザーの権限で動作します。連携したいプロジェクトにアクセスできるユーザーで発行してください。

ステップ 3:workrun に接続を追加する

  1. workrun で Backlog のアクション/トリガーをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「ホスト名」 フィールドに、ステップ 1 で確認したホスト名を入力します( は不要です)。
  1. 「APIキー」 フィールドに、ステップ 2 でコピーした API キーを貼り付けます。
  1. 「保存」 をクリックして接続を完了します。
💡
Backlog のトリガー(「新しい課題が追加されたら」「課題が追加または更新されたら」)を使う場合、Webhook はフローを有効にすると Backlog 側に自動で登録されます。Backlog の管理画面で手動設定する必要はありません。

ピースの設定項目

1. 課題IDまたは課題キー(必須)

  • 状態を更新したい課題のID(数字)または課題キーを入力します。
  • 課題キーは Backlog の課題画面に表示されている「プロジェクトキー-番号」の形式です。
[設定例]

2. 状態(必須)

  • 変更後の状態を一覧から選びます。
  • 選択肢は、上で入力した課題からプロジェクトを自動判定して読み込まれます。先に「課題IDまたは課題キー」を入力しないと選択肢は表示されません。
[設定例]

3. 完了理由(任意)

  • 課題を完了にする場合の完了理由を選びます。
  • 完了以外の状態に変更する場合は入力不要です。
[設定例]

4. コメント(任意)

  • 状態を変更するときに一緒に残すコメントを入力します。
[設定例]