AIに聞くお問い合わせ
AIに聞くお問い合わせ
workrun ヘルプサイト/カスタムAPI呼び出し

カスタムAPI呼び出し

このピースでできること

  • formrunのAPIのうち、他のピースとして用意されていない機能を、直接呼び出して実行します。
  • 接続のAPIキーは自動で付与されるため、認証用のヘッダーを自分で入力する必要はありません。

formrun の接続方法

formrun と workrun の連携方法は、使うピースによって 2 種類あります。
  • アクション（カード一覧の取得・メール送信など）を使う場合 → ステップ 1・2 の APIキー接続 が必要です
  • トリガー（Webhookを受信する）だけを使う場合 → 接続の作成は不要です。ステップ 3 の Webhook 設定のみ行ってください

ステップ 1：APIキーを取得する

  1. formrun にログインし、対象チームの 「チーム設定」 画面を開きます。
  1. 「API設定」 から API キーを発行します。
  1. 発行された API キーをコピーしておきます。

ステップ 2：workrun に接続を追加する

  1. workrun で formrun のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「＋ 新しい接続」 をクリックします。
  1. 「APIキー」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
  1. 「保存」 をクリックして接続を完了します。

ステップ 3：Webhook を設定する（トリガーを使う場合）

  1. workrun で formrun のトリガー 「Webhookを受信する」 をフローに追加します。
  1. トリガーの設定画面に表示される 「Webhook URL」 をコピーします。
  1. formrun の管理画面で、対象フォームの 「Webhook」 アプリをインストール し、「作成する」 をクリックします。
  1. タイトルに任意の名前を入力し、「連携先のWebhook URL」 に手順 2 でコピーした URL を貼り付けます。
  1. 「条件設定」 でトリガーとしたい条件を設定します。
  1. 「有効にする」 を選択し、「保存する」 をクリックします。
💡
トリガーの設定画面で認証方式を 「なし」または「ヘッダー認証」 から選べます。ヘッダー認証を選ぶと、ヘッダー名と値を追加で設定できます。

テスト方法

  • workrun の 「テストトリガー」 をクリック後、実際に formrun でトリガー条件を実行するとデータを受信できます。
  • formrun の管理画面で 「テスト送信する」 にチェックを入れて保存することでもサンプルデータを送信できます。

ピースの設定項目

1. URL（必須）

  • 呼び出したいAPIのURLを入力します。
  • 完全なURLでも、ベースURLからの相対パスでも指定できます。
    • 完全なURLの例：
    • 相対パスの例：
[設定例]

2. メソッド（必須）

  • APIを呼び出すときのHTTPメソッドを選びます（GET / POST / PUT / DELETE / PATCH）。
  • 情報を取得する場合はGET、新規作成する場合はPOST、更新する場合はPATCHを選ぶのが一般的です。
[設定例]

3. ヘッダー（任意）

  • APIへ送る追加のヘッダーを指定します。
  • 認証用のヘッダーは接続から自動で付与されるため、通常は入力不要です。
[設定例]

4. クエリパラメータ（任意）

  • URLの末尾に付け加える条件を指定します。
[設定例]

5. ボディ（任意）

  • POSTやPATCHなどで送るデータをJSON形式で指定します。
  • GETの場合は通常入力不要です。
[設定例]

6. 失敗時にエラーにしない（任意）

  • オンにすると、APIがエラーを返してもフローを止めずに次のステップへ進みます。
[設定例]

7. タイムアウト（秒）（任意）

  • APIからの応答を待つ最大秒数を指定します。
[設定例]