ウェブフックの作業
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
ウェブフックはフォームデータの宛先を定義します。ConnectやZapierなどのサードパーティ製品に接続してワークフローを作成できます。
フォームエディターでは、特定のフォームの設定やウェブフック設定を 編集 できます。
また、ダッシュボードの上部メニューにあるWebhooksタブですべてのウェブフックにアクセスし管理することもできます。
ウェブフックを選びましょう
以前にFormsで定義されたウェブフックのリストからウェブフックを選択できます。必要なウェブフックが利用できない場合は、新しいウェブフックを作成できます。
フォームのウェブフックを選択するには:
-
フォームエディターでフォームをOpenし、エディターの上部メニューでSettingsをクリックします。
-
Choose webhookドロップダウンリストをクリックし、以前に定義したウェブフックの中から1つを選択します。
-
クリックAdd。
ウェブフックを作成する
必要なウェブフックがまだ定義されていなければ、作成できます。
ウェブフックを作成するには:
-
エディターのフォームをOpenし、エディターの上部メニューでSettingsをクリックします。
-
SettingsページのWebhook欄の下に、Manage webhooksをクリックしてください。
-
クリックAdd。
-
Create Webhookページで、選択した認証タイプに応じて以下の項目を入力してください:
-
Authentication Type - OAuth 2、Basic、Api key、またはNo authenticationのいずれかを選択できます(推奨されません)。
-
Name - ウェブフックの名前を入力してください。
-
URL - 転送データの先。
-
-
クリックSubmit。
ウェブフックが作成されたかどうかの通知が届きます。
ウェブフックのテスト
フォームを有効化する前に、Webhookにフォームデータを提出してテストすることをお勧めします。
ウェブフックのテスト方法:
-
エディターのフォームをOpenし、エディターの上部メニューでSettingsをクリックします。
-
SettingsページのWebhook欄の下に、Test webhookをクリックしてください。
-
あなたのフォームが表示されます。欄に入力してSubmitをクリックします。
-
フォームから送られるURL、ペイロード(転送されるデータ)、リクエストヘッダー(メッセージのフォーマット)を示す、そのTest Form Submissionダイアログを確認してください。
注記データにはコード行 "test": trueが含まれており、これによりテストデータと顧客データをフィルタリングできます。
-
クリックSubmit。
テストが成功したかどうかは通知メッセージで通知されます。
プレビューモードでウェブフックをテストすることもできます。
フォームの提出がNegative response from the webhookを返す場合、それは次のことを意味します:
-
XM Cloudはペイロードを設定済みのウェブフックエンドポイントに正常に送信しました。
-
エンドポイントは応答しました(多くの場合HTTP 200)。
-
しかし、ウェブフックは失敗応答(isSuccessful: false)を返しました。
この場合、問題は通常ペイロード構造、受信端の検証エラー、またはフォームフィールドキーとWebhookの期待値の不一致に関連しています。
同様の問題を防ぐために:
-
一貫したフィールド命名規則を用いましょう。
-
フィールドキーにスペースや特殊文字は避けてください。
-
ウェブフックの検証ルールを文書化してください。
-
まずは最小限のペイロードで新しいフォームをテストしてください。
-
ウェブフックエンドポイントで詳細なログングを有効にしましょう。
-
展開前にペイロード構造を検証してください。
-
失敗したフォームと、動作するフォームをフィールドごとに比較してみましょう。
ウェブフックを編集する
データの宛先URLが変わった場合は、ウェブフックを更新する必要があるかもしれません。
ウェブフックを編集するには:
-
エディターのフォームをOpenし、エディターの上部メニューでSettingsをクリックします。
-
SettingsページのChoose webhookの下、Manage Webhooksをクリックしてください。
-
Webhooksページで削除したいウェブフックに移動し、More
> Editをクリックします。 -
ウェブフックダイアログでは、以下の編集が可能です:
-
Authentication Type
-
Name
-
URL
-
-
クリックSubmit。
ウェブフックを削除してください
フォームで既に使われていないウェブフックだけを削除できます。使用されているWebhookはWebhooksページでIn useとしてマークされています。
ウェブフックを削除するには:
-
エディターのフォームをOpenし、エディターの上部メニューでSettingsをクリックします。
-
Choose webhookのSettingsページで、Manage Webhooksをクリックしてください。
-
Webhooksページで削除したいウェブフックに移動し、More
> Deleteをクリックします。