事前入力用Webhook

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

Webhook の詳細

フィールドのプロパティ

プレフィル設定

検索アイコンのスタイル

概要

Prefill-Webhook フィールドは、外部サービスから取得したデータを使用してフォームフィールドに自動入力します。回答者が値を入力して検索アイコンをクリックすると、設定済みのエンドポイントにリクエストが送信されます。レスポンスに基づき、フォーム内でマッピングされたフィールドが自動的に入力され、より迅速でパーソナライズされた入力体験を提供します。これにより手入力が減り、精度が向上し、フォーム入力プロセスが効率化されます。フォームは入力された値をサービスに送信し、一致するデータを受信して、プレフィル設定に従ってフィールドを自動入力します。回答者は送信前に、プレフィルされた内容を確認または編集できます。

Prefill-Webhook の設定

Prefill-Webhook フィールドを設定するには、フォームを作成し、次の手順に従います。

［ビルダー］タブに移動します。
フィールドパネルで、［プレフィル］に移動します。
［Prefill-Webhook］フィールドをドラッグ＆ドロップしてフォームに追加します。
4 つのステップで設定を完了するための設定ポップアップが表示されます。

フィールド設定
Webhook 設定
テストと検証
プレフィルマッピング

各手順について、以下で詳しく説明します。

1. フィールド設定

このセクションでは、基本的なフィールド設定を行います。

Prefill-Webhook フィールドのフィールドラベルを入力します。
フィールドタイプを選択します。
サポートされるフィールドタイプは、シングルライン、数値、メール、電話番号、ドロップダウン、ラジオです。
［次へ］をクリックします。

2. Webhook 設定

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

Webhook の詳細

Webhook URL

Webhook URL は、検索時にフォームから外部サービスへリクエストを送信するエンドポイントです。データを取得する外部サービスの完全な URL を入力します。

使用できる Webhook URL メソッドは次のとおりです。

GET
POST

認証タイプ

使用する認証タイプを選択します。

一般：エンドポイントが公開されている場合、またはヘッダーやクエリパラメーターで認証を行う場合に使用します。
接続：コントロールパネルで事前に設定した接続を使用します。［接続］を選択した場合は、［接続名］ドロップダウンリストから適切な接続を選択します。新しい接続を追加したばかりの場合は、更新アイコンをクリックしてリストに反映させます。接続の作成について詳しく読む。

メモ: 接続名には、有効な既存の接続のみが表示されます。接続の詳細については、関連ドキュメントを参照してください。

データ取得方法

外部ソースからのデータ取得は、次のいずれかの方法で行えます。

URL パラメーター
リクエスト本文
カスタムヘッダー

URL パラメーター

URL パラメーターは、ユーザーがフォームの Prefill-Webhook フィールドに値を入力した際に、その値を外部サービスへ送信し、フォームをプレフィルするためのデータを取得するために使用します。
URL Parameters

データ検索時、Webhook は URL パラメーターをクエリ文字列として含めます。Prefill-Webhook フィールドに入力された値が URL パラメーターとしてマッピングされている場合、その値がクエリパラメーターの値として送信されます。外部サービスはこの情報を使用して、フォームをプレフィルするために必要なデータを返します。

例:Prefill-Webhook フィールドが「メールアドレスを入力」となっており、その値が URL パラメーター「email」にマッピングされている場合、ユーザーがフィールドに richard@zylker.com を入力して検索すると、Webhook は次のようなリクエストを送信します。https://api.zylker.com/getEmpInfo?email=##PROTECTED_0##

関連するデータを絞り込むために、追加情報を付与することもできます。たとえば、「department」という名前のパラメーターに「IT」という値を追加した場合、Webhook は次のようなリクエストを送信します。

https://api.zylker.com/getEmpInfo?email=##PROTECTED_0##&department=IT

［＋］アイコンをクリックしてパラメーター名と値を入力することで、パラメーターを追加できます。［カスタム入力］をクリックすると、パラメーター名に対してカスタム値を設定することもできます。

リクエスト本文

リクエスト本文は、外部サービスに情報を送信してデータを取得し、フォームをプレフィルするもう 1 つの方法です。対応形式は JSON と テキスト です。リクエスト本文は POST メソッドでのみ使用されます。

例 - 回答者のメールアドレスと部署に基づいてデータを取得するサンプル JSON：

{

'メール': '${zf:SingleLine}',

'dept': 'IT'

}

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

メモ:

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

［次へ］をクリックします。

3. テストと検証

この手順では、Webhook をテストし、Prefill-Webhook フィールドに入力された値に基づいて正しいデータが取得されることを検証できます。

［フィールド］セクションにテスト用の値を入力します。
［Run テスト］をクリックして Webhook を実行します。
受信したレスポンスを確認し、データが正しいことを検証します。

［次へ］をクリックします。

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

4. プレフィルマッピング

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

外部サービスから取得したデータでプレフィルしたいフォーム項目をマッピングするには、

[項目を選択] をクリックして、フォーム項目を追加します。
追加したフォーム項目に対応する右側の入力ボックスをクリックします。
JSON レスポンスを表示するポップアップが開きます。必要なデータを含む JSON レスポンス内のキーを特定し、マッピング用に選択します。
プレフィルしたいすべてのフォーム項目について、この操作を繰り返します。

日付項目および日付-時間項目の場合: 期待する形式を選択できます。Webhook から受信した日付値は、選択した形式からフォームの設定で構成されている日付形式（[設定] > [一般] > [日付と時間] > [日付形式]）に変換され、有効なフォームにプレフィルされます。
Date and Time fields mapping

サブフォーム項目の場合: フォーム内にサブフォーム項目があり、それらもプレフィルしたい場合は、同様の手順で該当する外部サービスのデータ項目とサブフォーム項目をマッピングします。
Subform Mapping

[保存] をクリックして、Prefill-Webhook 項目の設定を完了します。

メモ:

Prefill Mapping セクションでは、サブフォーム内でマッピングされた項目を含めて、最大 50 個の項目をマッピングできます。
Prefill-Webhook 項目に項目エイリアス経由でプレフィルされた値がある状態でフォームが読み込まれると、自動的に検索が実行されます。このとき、マッピングされた項目は、回答者が検索アイコンを手動でクリックしなくても、Webhook を通じて自動的にプレフィルされます。

項目プロパティ

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

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

Prefill Configuration

Prefill Configuration では、プロパティパネル内にプレフィルデータのデータ元（この例では Webhook）が表示されます。設定済みのプレフィル内容をすばやく確認するには、[概要]ボタンをクリックします。編集する場合は、[編集]ボタンをクリックします。

Prefill Configuration 概要

[概要] ボタンをクリックすると、Prefill Configuration 概要が表示されます。ここでは、設定済みプレフィルの概要として、プレフィルデータのデータ元（この例では Webhook）、Webhook URL、使用している HTTP メソッド（GET/POST）、URL パラメーター/ヘッダー、およびプレフィルマッピングの詳細が表示されます。設定画面を開き直さなくても、構成内容をすばやく確認できます。
Prefill Configuration Summary