カスタムAPI呼び出し
このピースでできることBacklog の接続方法ステップ 1：ホスト名を確認するステップ 2：API キーを発行するステップ 3：workrun に接続を追加するピースの設定項目1. URL（必須）2. メソッド（必須）3. ヘッダー（任意）4. クエリパラメータ（任意）5. ボディ（任意）6. 失敗時にエラーにしない（任意）7. タイムアウト（秒）（任意）
このピースでできること
- Backlog のAPIのうち、他のピースとして用意されていない機能を、直接呼び出して実行します。
- 接続のAPIキーは自動で付与されるため、認証情報を自分で入力する必要はありません。
- 接続で指定したホスト名が自動で使われるため、 / のどちらのスペースでも同じ設定で動作します。
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. URL（必須）
- 呼び出したいAPIのURLを入力します。
- 完全なURLでも、ベースURLからの相対パスでも指定できます。
- 完全なURLの例：
- 相対パスの例：
[設定例]
2. メソッド（必須）
- APIを呼び出すときのHTTPメソッドを選びます（GET / POST / PUT / DELETE / PATCH）。
- 情報を取得する場合はGET、新規作成する場合はPOST、更新する場合はPATCHを選ぶのが一般的です。
[設定例]
3. ヘッダー（任意）
- APIへ送る追加のヘッダーを指定します。通常は入力不要です。
[設定例]
4. クエリパラメータ（任意）
- URLの末尾に付け加える条件を指定します。
- 認証用のAPIキーは自動で付与されるため、ここに入力する必要はありません。
[設定例]
5. ボディ（任意）
- POSTやPATCHなどで送るデータをJSON形式で指定します。
- GETの場合は通常入力不要です。
[設定例]
6. 失敗時にエラーにしない（任意）
- オンにすると、APIがエラーを返してもフローを止めずに次のステップへ進みます。
[設定例]
7. タイムアウト（秒）（任意）
- APIからの応答を待つ最大秒数を指定します。
[設定例]