事前入力用Webhook

事前入力用Webhook

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

概要

プレフィル Webhook 項目を使用すると、外部サービスから取得したデータでフォーム項目を動的に自動入力できるため、入力作業をより速く、正確に行えます。回答者がこの項目に値を入力して検索アイコンをクリックすると、フォームから設定済みのサービスにリクエストが送信されます。レスポンスに基づいて、関連するフォーム項目が自動的にプレフィルされ、回答者ごとにパーソナライズされたスムーズな入力体験を提供できます。



メリット:
  1. フォーム項目を自動入力することで、回答者の時間と手間を削減できます。
  2. 手入力のミスを減らし、データの正確性を向上させます。
  3. 回答者ごとにパーソナライズされた体験を提供できます。

動的プレフィルはどのように動作しますか？

  1. 回答者がフォームを開き、プレフィル Webhook 項目にデータを入力して検索アイコンをクリックします。

  2. 検索が行われると、フォームはプレフィル Webhook 項目に入力された値を含めて外部サービスにリクエストを送信し、データを取得します。

  3. 外部サービスがリクエストを処理し、プレフィル用のデータを返します。

  4. フォームは外部サービスからレスポンスを受信し、プレフィル設定に基づいてフォーム項目にデータが自動入力されます。

  5. 回答者はプレフィルされたフォームを確認し、残りの項目を入力したり、必要に応じてプレフィルされた情報を調整したりできます。

プレフィル Webhook の設定

プレフィル Webhook 項目を設定するには、フォームを作成し、次の手順に従います。
  1. ［ビルダー］タブに移動します。
  2. ［項目］パネルで、［詳細］に移動します。
  3. プレフィル Webhook 項目をドラッグ＆ドロップしてフォームに追加します。
  4. 設定を完了するための 4 つのステップを含む設定ポップアップが表示されます。
    1. 項目設定
    2. Webhook 設定
    3. Webhook テスト
    4. プレフィルマッピング
各手順について、以下で詳しく説明します。

1. 項目設定

Field Configuration
このセクションでは、基本的な項目設定を行います。
  1. 項目ラベルにプレフィル Webhook 項目のラベルを入力します。
  2. 項目タイプを選択します。
  3. サポートされる項目タイプは、シングルライン、数値、メール、電話番号、ドロップダウン、ラジオです。
  4. ［次へ］をクリックします。

2. Webhook 設定
Webhook Settings

このセクションでは、Webhook を設定します。

Webhook の詳細

Webhook URL
Webhook URL は、検索時にフォームから外部サービスへリクエストを送信するエンドポイントです。データを取得する外部サービスの完全な URL を入力します。
サポートされている Webhook URL のメソッドは次のとおりです。
  1. GET
  2. POST

認可タイプ
使用する認可タイプを選択します。
  1. 一般: エンドポイントが公開されている場合、またはヘッダーやクエリパラメーターで認証を行う場合に使用します。
  2. 外部連携: コントロールパネルで事前に設定した接続を使用します。外部連携を選択した場合は、［接続名］ドロップダウンリストから適切な接続を選択します。新しい接続を追加したばかりの場合は、更新アイコンをクリックしてリストに反映させてください。外部連携の作成について詳しく読むことができます。
Notesメモ: 接続名には、既存の有効な外部連携のみが表示されます。外部連携の詳細についてはヘルプをご覧ください。

データ取得方法
外部ソースからのデータ取得は、次のいずれかの方法で行えます。
  1. URL パラメーター
  2. リクエスト本文
  3. カスタムヘッダー

URL パラメーター
URL パラメーターを使用すると、フォームの検索項目にユーザーが値を入力した際に、その情報を外部サービスへ送信し、フォームをプレフィルするためのデータを取得できます。
URL Parameters
データ検索時、Webhook は URL パラメーターをクエリ文字列として含めます。検索項目に入力された値が URL パラメーターとしてマッピングされている場合、その値がクエリパラメーターの値として送信されます。外部サービスはこの情報を使用して、フォームをプレフィルするために必要なデータを返します。
例:プレフィル Webhook 項目が「メールアドレスを入力」となっており、その値が URL パラメーター email にマッピングされている場合、ユーザーが項目に richard@zylker.com を入力して検索すると、Webhook は次のようなリクエストを送信します。https://api.zylker.com/getEmpInfo?email=##PROTECTED_0##

関連するデータを絞り込むための追加情報を付与することもできます。たとえば、department という名前のパラメーターに IT という値を追加すると、Webhook は次のようなリクエストを送信します。
［＋］アイコンをクリックしてパラメーター名と値を入力することで、パラメーターを追加できます。また、［カスタム入力］をクリックして、パラメーター名に対してカスタム値を設定することもできます。

リクエスト本文
リクエスト本文は、外部サービスに情報を送信してデータを取得し、フォームをプレフィルするもう 1 つの方法です。対応形式は JSON と テキスト です。リクエスト本文は POST メソッドでのみ使用されます。
例 - 回答者のメールアドレスと部署に基づいてデータを取得するためのサンプル JSON:
{
'メール': '${zf:SingleLine}',
'dept': 'IT'
}
Request Body

カスタムヘッダー
Webhook リクエストに含めるカスタムヘッダー名と値を設定できます。ヘッダーの名前と、そのヘッダーに関連付ける値を入力します。
Custom Headers

Notes
メモ:
  1. プレフィル Webhook 項目は、特定のデータを取得するための識別子を Webhook に提供するため、URL パラメーターまたはリクエスト本文のいずれかに必ず含める必要があります。
  2. URL パラメーターとカスタムヘッダーは、それぞれ最大 5 つまで追加できます。
  3. URL パラメーターとリクエスト本文を合わせて、フォーム項目は合計 5 項目まで追加できます。サポートされる項目タイプは、シングルライン、数値、メール、電話番号、ドロップダウン、ラジオです。
［次へ］をクリックします。

3. Webhook テスト

Webhook Test
この手順では、Prefill-Webhook項目に入力された値に基づいて正しいデータが取得されるかどうかを確認するために、Webhook をテストできます。
  1. 項目セクションにテスト用の値を入力します。
  2. [Run テスト] をクリックして Webhook を実行します。
  3. 受信したレスポンスを確認し、データが正しいことを検証します。
Run Webhook Test
次をクリックします。

Notes
メモ: 項目セクションには、URL パラメーターおよびリクエスト本文で設定したすべての項目が表示されます。

4. Prefill Mapping

次の手順では、取得したデータの情報をどのフォーム項目に自動入力するかを決定します。

外部サービスから取得したデータで自動入力したいフォーム項目をマッピングするには、
  1. [項目を選択]をクリックして、フォーム項目を追加します。
    Prefill Mapping - Choose a Field
  2. 追加したフォーム項目に対応する右側の入力ボックスをクリックします。
  3. JSON レスポンスを表示するポップアップが開きます。必要なデータを含む JSON レスポンス内のキーを特定し、マッピング用に選択します。
    Select value in JSON response to map
  4. 自動入力したいすべてのフォーム項目について、この操作を繰り返します。
日付項目および日付-時間項目の場合: 期待する形式を選択できます。選択した形式で Webhook から受信した日付値は、フォームの設定（[設定] > [一般] > [日付と時間] > [日付形式]）で設定されている日付形式に変換され、有効なフォームに自動入力されます。
Date and Time fields mapping
サブフォーム項目の場合: フォーム内にサブフォーム項目があり、それらも自動入力したい場合は、同様の手順で該当する外部サービスのデータ項目とサブフォーム項目をマッピングします。
Subform Mapping
[保存]をクリックして、Prefill-Webhook項目の設定を完了します。

Notes
メモ:
  1. Prefill Mappingセクションでは、サブフォーム内でマッピングされた項目を含めて、最大 50 個の項目をマッピングできます。
  2. フォームが読み込まれた際に、Prefill-Webhook項目に項目エイリアス経由で値があらかじめ入力されている場合、検索が自動的に実行されます。このとき、マッピングされた項目は、回答者が検索アイコンを手動でクリックしなくても、Webhook を通じて自動入力されます。
  3. 1 つのフォームに追加できる Prefill-Webhook項目は 1 つのみです。
  4. フォームにすでにZoho CRM 項目がある場合は、Prefill-Webhook項目を追加できません（その逆も同様です）。
  5. Prefill-Webhook項目は複製できません。    
 

 項目プロパティ    

Prefill-Webhook Field Properties
Prefill-Webhook項目を設定した後は、標準の項目プロパティは、選択した項目タイプ（単一行、数値、メール、電話番号、ドロップダウン、ラジオ）のプロパティと同じになります。

項目を設定した後でも、Webhook Configurationおよび検索アイコンのスタイルは、後からプロパティパネル内で編集できます。

Webhook 設定 

Webhook 設定 では、プロパティパネル内に Webhook URL とメソッド（GET/POST）が表示されます。設定済み Webhook をすばやく確認するには、概要ボタンをクリックします。編集する場合は、編集ボタンをクリックします。

 
Webhook 設定の概要 

Webhook 設定の概要を表示するには、概要ボタンをクリックします。ここでは、設定済み Webhook の概要として、Webhook URL、使用中の HTTP メソッド （GET/POST）、URL パラメーター/ヘッダー、プレフィルマッピングの詳細が表示されます。フォーム全体の設定画面を開き直さなくても、設定内容をすばやく確認できます。

Webhook Configuration Summary

 Webhook を編集 

設定画面を再度開いてWebhook 設定、Webhook テスト、プレフィルマッピングの詳細を必要に応じて変更するには、編集ボタンをクリックします。

Edit Webhook Configuration

 

 検索アイコンのスタイル 

有効なフォームで、回答者に対して検索操作をどのように表示するかは、検索アイコンのスタイルプロパティで選択できます。検索アイコンは、次の表示スタイルでカスタマイズできます。

 インラインアイコン 

検索アイコンが入力フィールドの右側に、フィールド内に直接表示されます。
Inline Icon

 スタンドアロンアイコン 

検索アイコンが、フィールドのすぐ横に配置された、個別のクリック可能なアイコンとして表示されます。

Standalone Icon

 ボタン 

検索操作を専用のボタンとして表示します。このアイコンスタイルを選択すると、ボタンのラベルプロパティが表示されます。ここで、ボタンに表示するテキスト（例：「検索」「Lookup」「Fetch Data」など）をカスタマイズできます。

Button

Notes
メモ:
  1. プレフィル Webhook フィールドを設定した後、有効なフォームで検索アイコンをクリックすると、Webhook がトリガーされ、マッピングされたフィールドが自動的にプレフィルされます。
  2. ボタンのラベルは空欄にはできず、最大 10 文字まで指定できます。

フィールドタイプごとの応答形式

フォーム項目に対応するレスポンス形式を確認します。

項目種類 例 レスポンス形式
単一折れ線グラフ、複数折れ線グラフ、住所、名前、ドロップダウン、ラジオボタン Richard
数値、評価、スライダー 100
通貨、小数 100。5
メール richard@zylker.com
Webサイト www.zylker.com
電話番号 2436673893
日付 2024-08-23 yyyy-MM-dd
時間 14:30 HH:mm
日付-時間 2024-12-30T10:05:59。564600+08:00 yyyy-MM-dd'T'HH:mm:ss。SSSXXX
チェックボックス、複数選択、画像選択 [100。50, 101。50] JSON 配列
判定ボックス 真
サブフォーム 
[
  {
    <SUBFORM_ROW_1>
  },
  {
    <SUBFORM_ROW_2>
  }
]
 JSON 配列

料金

検索が 1 回実行されるたびに、ウォレットクレジットが 1 件分消費されます。つまり、同じ回答者が複数回検索を行った場合でも、1 回の検索ごとにウォレットクレジットを 1 件分使用します。基本的に、新しい検索操作が行われるたびにクレジットが差し引かれ、同じ回答者が何度繰り返してもカウントされます。
利用可能な検索操作の合計数は、選択したサブスクリプションプランによって次のように異なります。

プラン 上限
試用
100
基本 10000
スタンダード 25000
プロフェッショナル 75000
プレミアム 150000
Zoho One 150000

Notes
メモ:
  1. これは、すべてのユーザーとフォームを含む、組織アカウント全体の合計上限です。
  2. アカウント使用状況で利用状況の詳細を確認できます。
  3. 上限に達すると、そのフォームへのアクセスはブロックされます。
  4. 「プレフィル - Webhook」項目の「次の値と等しくない」は、無料プランでは利用できません。
  5. 上限は、請求間隔に基づき毎月自動的にリセットされます。

    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






                          Latest Feature Updates



                                  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.