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 を指定します。

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

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

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

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

      1. データの内容パラメーターでパラメーター名を定義し、Parameter 値で対応するフォーム項目を選択します。
      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 が有効になります。
Infoホワイトリストに登録する IP アドレスについては、こちらをクリックして参照してください

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

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

    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts









                                  Resources

                                  Videos

                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                  eBooks

                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                  Webinars

                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                  CRM Tips

                                  Make the most of Zoho CRM with these useful tips.