Webhook連携の基本的な設定方法を教えてください

変更日 金, 10月 10 で 7:27 午後

フォームメーラーのWebhook連携機能を利用すると、フォームへの回答データを、様々な外部サービスにリアルタイムで自動送信できます。

ここでは、連携を始めるための基本的な設定手順をご説明します。


1. Webhook設定画面を開く

  1. 該当のフォームの「各種設定」→「Webhook設定」に移動します。
  2. 「Webhookを追加」ボタンをクリックし、webhook設定画面を開きます。

 

グラフィカル ユーザー インターフェイス, テキスト, アプリケーション

AI 生成コンテンツは誤りを含む可能性があります。


 

2. 各項目を設定する


設定画面には、主に以下の項目があります。

項目名

説明

入力例

Webhook名

管理用の名前です。連携先サービスがわかるよう任意で設定してください。

Slack通知

URL

連携先サービス(Slackなど)が発行する送信先のURL(エンドポイントURL)を入力します。

https://hooks.[サービスドメイン]/services/[トークン]


※連携したいサービスの管理画面などから取得してください。

カスタムヘッダー

連携先が認証を必要とする場合などに設定します。不要であれば空欄で問題ありません。

Authorization:  [APIキー]

リクエストボディ

外部サービスに送信するデータの中身(JSON形式など)を記述します。最も重要な項目です。

{"text":"投稿がありました"}

※連携サービスごとに仕様が異なる場合がありますので、各サービスのwebhook仕様をご確認ください。

ステータス

Webhookを有効にするか、無効にするかを選択します。

webhook連携を使用する場合は「有効にする」を選択してください。


特に重要な「リクエストボディ」の設定

リクエストボディには、連携先サービスがデータを正しく受け取るために必要な形式で内容を記述します。JSON形式で記述する必要がありますのでご注意ください。

 

① 固定のメッセージを送る場合

連携先に「フォーム名」だけを通知したいなど、固定のメッセージを送りたい場合は、リクエストボディに以下のように記述します。

JSON

{"text":"フォーム「%%_FORM_NAME_%%」に新しい投稿がありました。"}


② フォームの回答内容を引用する場合

送信された回答データをリクエストボディに含めるには、編集画面下部の「投稿者の回答を引用」ボタンをクリックして表示される変数を利用します。

例えば、フォームの「お名前」という質問への回答を連携先に送りたい場合、リクエストボディの適切な位置にその質問の変数名を記述します。(変数名はフォームごとに異なります)


記述例:

 

{"text":"フォーム名は%%_FORM_NAME_%%です。\nメールアドレスは%%_5298609_%%です"}


※「""」で囲まれた値の中では改行できません。テキスト内で改行したい場合は改行したい場所に改行コード「\n」を記載してください。


3. Webhookを保存し、テストする

  1. すべての入力が完了したら、画面下部の「設定を更新」ボタンをクリックして設定を保存します。
  2. 設定後、実際にフォームからテスト回答を送信し、連携先サービス(Slackなど)にデータが正しく送信・表示されているかを確認してください。


エラーが表示される場合は

「設定を更新」ボタンをクリックした際に、JSONの記述に問題がないにも関わらず

Webhookの送信テストを実行した結果、送信先からエラーが返されました。WebhookのURLや設定内容をご確認ください。

 というエラーが表示される場合は、連携先のサービスの仕様で許されていない内容がJSONに含まれている可能性があります。

例:キーは"text"でなければならない等

この記事は役に立ちましたか?

それは素晴らしい!

フィードバックありがとうございます

お役に立てず申し訳ございません!

フィードバックありがとうございます

この記事に改善できることがあれば教えてください。

少なくとも一つの理由を選択してください
CAPTCHA認証が必要です。

フィードバックを送信しました

記事の改善におけるご協力ありがとうございます。