Webhookを受信する(トリガー)
このピースでできることformrun の接続方法ステップ 1:APIキーを取得するステップ 2:workrun に接続を追加するステップ 3:Webhook を設定する(トリガーを使う場合)テスト方法ピースの設定項目1. 認証(必須)2. 名前(認証が「ヘッダー認証」の場合は必須)3. 値(認証が「ヘッダー認証」の場合は必須)取得できる情報利用例出力例(抜粋)
このピースでできること
- formrunからのWebhookデータを受信して、ワークフローを開始します。
- フォームへの回答などをきっかけにワークフローをトリガーできます。
- 認証なし、またはヘッダー認証から選択して、セキュリティを確保できます。
formrun の接続方法
formrun と workrun の連携方法は、使うピースによって 2 種類あります。
- アクション(カード一覧の取得・メール送信など)を使う場合 → ステップ 1・2 の APIキー接続 が必要です
- トリガー(Webhookを受信する)だけを使う場合 → 接続の作成は不要です。ステップ 3 の Webhook 設定のみ行ってください
ステップ 1:APIキーを取得する
- formrun にログインし、対象チームの 「チーム設定」 画面を開きます。
- 「API設定」 から API キーを発行します。
- 発行された API キーをコピーしておきます。
ステップ 2:workrun に接続を追加する
- workrun で formrun のアクションをフローに追加します。
- 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
- 「APIキー」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
- 「保存」 をクリックして接続を完了します。
ステップ 3:Webhook を設定する(トリガーを使う場合)
- workrun で formrun のトリガー 「Webhookを受信する」 をフローに追加します。
- トリガーの設定画面に表示される 「Webhook URL」 をコピーします。
- formrun の管理画面で、対象フォームの 「Webhook」 アプリをインストール し、「作成する」 をクリックします。
- タイトルに任意の名前を入力し、「連携先のWebhook URL」 に手順 2 でコピーした URL を貼り付けます。
- 「条件設定」 でトリガーとしたい条件を設定します。
- 「有効にする」 を選択し、「保存する」 をクリックします。
トリガーの設定画面で認証方式を 「なし」または「ヘッダー認証」 から選べます。ヘッダー認証を選ぶと、ヘッダー名と値を追加で設定できます。
テスト方法
- workrun の 「テストトリガー」 をクリック後、実際に formrun でトリガー条件を実行するとデータを受信できます。
- formrun の管理画面で 「テスト送信する」 にチェックを入れて保存することでもサンプルデータを送信できます。
ピースの設定項目
Webhook URL・説明・使用方法・テスト方法が表示されます。これらは表示専用です。Webhook URLをformrunに登録してください。このトリガーでは接続(APIキー)の選択は不要です。
1. 認証(必須)
- Webhook受信時の認証方式を選択します。
- 「なし」を選択すると、認証なしでWebhookを受信します。
- 「ヘッダー認証」を選択すると、HTTPヘッダーを使用して認証を行います。
- 本番環境では「ヘッダー認証」を推奨します。
- 初期値は「なし」()です。「ヘッダー認証」()を選ぶと、「認証フィールド」()内に「名前」()と「値」()が表示され、どちらも必須になります。
2. 名前(認証が「ヘッダー認証」の場合は必須)
- 認証で利用するHTTPヘッダーの名前を指定します。
- formrunのWebhook設定と同じヘッダー名を設定してください。
- ヘッダー名は小文字に変換されて検証されます。
3. 値(認証が「ヘッダー認証」の場合は必須)
- 認証で利用するHTTPヘッダーの値を指定します。
- formrunのWebhook設定と同じ値を設定してください。
- 推測されにくい値を使用することを推奨します。
取得できる情報
formrunから受信したWebhookの本文・ヘッダーなどを、1件のデータとして後続のステップで利用できます。認証が「なし」の場合、またはヘッダー認証に成功した場合にデータが渡されます。ヘッダー認証の値が一致しない場合はフローを起動しません。
| キー | 内容・条件 |
|---|---|
| Webhookの本文。業務データはこの配下を参照します。 | |
| 受信したHTTPヘッダー。含まれるキーは送信内容によって変わります。 | |
| Webhook URLに付けられたクエリパラメーター。指定がなければ空のオブジェクトです。 | |
| 受信したHTTPメソッド。 | |
| 受信本文の元の文字列。受信形式によっては含まれません。通常の転記には body 配下を利用します。 | |
| formrunから送信された項目の値。固定の項目一覧はなく、Webhookの送信設定・イベントによって変わります。 |
利用例
フォーム回答などの本文に含まれる値を、Google Sheetsへの転記や通知に利用できます。後続のステップでは、本文の項目を 配下から選択してください。
出力例(抜粋)
以下は階層を示す例です。 は説明用の仮のキーで、実際の業務項目名ではありません。
実際の項目名・値・配列の有無は送信元に依存します。workrunの「テストトリガー」を開始して実際のイベントを発生させ、受信した 配下のキーを確認してからマッピングしてください。