Webhookの設定方法

Webhookの設定方法

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

シンプルに言うと、Webhook とは、あるイベントが発生したタイミングで、あるシステムやアプリケーションから別のシステムやアプリケーションへリアルタイムでデータを送信する仕組みです。Webhook は基本的に、イベント発生時に指定した送信先（URL）へ送られる通知です。Zoho Forms では、フォームの入力が受信されると同時に、その送信内容を任意の URL やサードパーティ Web アプリケーションへ送信できます。

Zoho Forms で収集したデータを自社の Web アプリケーションで処理したり、業務ワークフローで利用したい場合は、Webhook を使用できます。API を使用しなくても、収集されたフォーム送信データを即座に受け取ることができます。
たとえば、収集したデータを直接データベースに保存したり、自社 Web サイトに表示したり、その他さまざまな処理を行えます。

Webhook を設定するには、

  1. Developer & 自動化の下にあるIntegrationsタブをクリックし、Webhookを選択します。

  2. Webhook を設定をクリックし、次の詳細を入力します。

    Webhooks configuration

    • Webhook URL:フォーム送信データの送信先となる URL を指定します。

    • コンテンツの種類: Zoho Forms は、HTTP POST リクエストを使用して Webhook URL に通知を送信します。フォームデータを含むリクエスト本文は、次のいずれかのコンテンツ形式で送信されます。
      コンテンツの種類
      		 送信されるデータ
      application/json
      		 ファイル添付を除くすべて
      application/x-www-form-urlencoded
      		 フォーム添付およびサブフォームデータを除くすべて
      multipart/form-data
      		 サブフォームデータを除くすべて

      各コンテンツタイプのレスポンス形式については こちらを参照してください。

    • 認可タイプ: 使用する認可タイプとして一般、またはコントロールパネルで設定済みの接続を選択します。認可タイプに外部連携を選択した場合は、接続名の一覧から該当する接続を選択できます。
      新しい接続を追加した場合は、接続名ドロップダウンリストの横にある更新アイコンをクリックして、追加した接続を選択してください。外部連携の作成について詳しくはこちら。
      Notes
      メモ: 接続名には、有効な既存の外部連携のみが表示されます。外部連携の詳細については、関連ドキュメントを参照してください。

    • データの内容パラメーター: このセクションでは、Webhook で送信するデータの対象となる項目を選択します。

      1. データの内容パラメーターでパラメーター名を定義し、パラメーター値で対応するフォーム項目を選択します。
      2. コンテンツの種類に application/json を使用する場合、Webhook を使ってサブフォームからのデータも送信できます。
      3. フォームで 支払い項目を使用している場合、Webhook を通じて支払いの詳細を送信できます。サポートされる項目は、支払い金額、支払いステータス、支払い通貨、支払い取引 IDです。フォーム送信と支払いステータスは同時に完了しないため、Zoho Forms では通常、取引ステータスとフォーム送信を非同期で送信します。

        非同期の支払い取引はどのように動作しますか？
        フォーム送信の後、回答者は支払いサイトにリダイレクトされます。最初に、支払い取引に対して「保留中」ステータスが数秒以内に Webhook 経由で送信されます。最終的なレスポンスは、購入者が取引を実行したタイミングでのみ確定します。
メモ: 支払い項目を設定する際は、ワークフローオプションを有効にすることを推奨します。これにより、「保留中」ステータスではなく、リアルタイムの支払いステータスと取引 ID が Webhook 経由で送信されるようになります。
  1. URL パラメーター: 収集したデータに加えて追加情報も送信したい場合は、このセクションで指定できます。たとえば、送信されるリクエストの頻度を制御するためのシークレットキーを含めることができます。これにより、認証済みリクエストのみを抽出してフィルタリングするのに役立ちます。これらのパラメーターは、URL のクエリ文字列として追加されます。 パラメーターを追加をクリックし、表示されるテキストボックスにパラメーター名と値を入力します。

  2. カスタムヘッダー: 収集したデータと共に送信するカスタムヘッダー名と値を設定できます。

    例
    Webhook URL に基本認証を設定している場合は、次のようにカスタムヘッダーを設定することで、対応するヘッダーを受け取ることができます。
    Custom Headers

    カスタムヘッダー「Authorization」は次のように表示されます。

    Authorization: Basic dXNicm5hbWU6cGFzc3dvcmQ=

Notes

メモ: カスタムヘッダーを設定する際は、次の点に注意してください。

  1. 標準（システム）ヘッダーを再定義することはできません。
  2. カスタムヘッダー名には英数字のみ使用できます。使用可能な記号は、アンダースコア（_）、ピリオド（.）、ハイフン（-）のみです。
  3. 重複する名前は使用できません。
保存をクリックして設定を保存すると、このフォームで Webhook が有効になります。
InfoWebhook を IP 制限環境で動作させるためのホワイトリスト IP アドレスについては、こちらをクリック。

連携エラーの原因を修正した後に、連携サービスへ値を再送信する方法

  1. フォームのすべてのエントリーセクションに移動します。
  2. 左上にあるすべてのエントリーフィルタードロップダウンをクリックします。
  3. 一覧をスクロールし、Webhook - 失敗エントリーオプションを選択します。
    Failed entries
  4. 失敗したエントリーを選択し、再送信をクリックします。
Notes
メモ: 失敗したエントリーを再送信できるのは 2 回までです。

連携エラー時のアラート設定

連携の設定を保存したら、連携が失敗した際にメールアラートを受け取るように設定できます。
設定手順は次のとおりです。
  1. 画面右上の[アラートを設定]をクリックします。
  2. メールアラートのテンプレートを設定し、[保存]をクリックします。
    Integration Failure Alert
  3. 連携エラー時のメールアラートの受信を停止するには、[アラートを削除]をクリックします。
Notes
メモ:
  1. 連携エラー時のメールアラートを設定できるのは、有料プランのみです。
  2. メールアラートは、組織内の最大5ユーザーまで送信できます。
  3. メールアラートは、24時間以内に発生した最初の連携エラー時にのみ送信されます。