---
title: "ウェブフックの作業"
slug: "work-with-webhooks"
abstract: "フォーム設定で、フォームデータの宛先を定義するウェブフックを選択し、作成し、テストし、編集し、削除します。"
---
# ウェブフックの作業

ウェブフックはフォームデータの宛先を定義します。ワークフローを作成するために、ConnectやZapierなどのサードパーティ製品に接続できます。

フォームエディターでは、特定のフォームの設定やウェブフック設定を [編集](https://doc.sitecore.com/sai/ja/users/sitecoreai/design-components/forms/edit-form-settings.html "Edit form settings") できます。

> !ヒントダッシュボードの上部メニューにあるWebhooksタブで、すべてのウェブフックにアクセスして管理することもできます。

## ウェブフックを選びましょう

Formsで以前に定義されたウェブフックのリストからウェブフックを選択できます。必要なウェブフックが利用できない場合は、新しいウェブフックを作成できます。

フォームのウェブフックを選択するには:

1.  フォームエディターでフォームを開き、エディターの上部メニューで **「設定**」をクリックします。
2.  「 **ウェブフック選択** 」ドロップダウンリストをクリックし、以前に定義したウェブフックの中から1つを選択します。
3.  **追加**をクリックします。

## ウェブフックを作成する

必要なウェブフックがまだ定義されていなければ、作成できます。

ウェブフックを作成するには:

1.  エディターでフォームを開き、エディターの上部メニューで **「設定**」をクリックします。
    
2.  **設定**ページの**Webhook**フィールドの下、「**Webhooks管理**」をクリックします。
    
3.  **追加**をクリックします。
    
4.  Create **Webhook**ページで、選択した認証タイプに応じて以下の項目を入力してください:
    
    -   **認証タイプ** - **OAuth 2**、 **Basic**、 **APIキー**、または **認証なし** (推奨なし)から選択してください。
    -   **名前** - ウェブフックの名前を入力してください。
    -   **URL** - 転送されたデータの送信先。
5.  **「送信**」をクリックします。
    
    ウェブフックが作成されたかどうかの通知が届きます。
    

## ウェブフックのテスト

フォームを有効化する前に、Webhookにフォームデータを提出してテストすることをお勧めします。

ウェブフックのテスト方法:

1.  エディターでフォームを開き、エディターの上部メニューで **「設定**」をクリックします。
    
2.  **設定**ページの**Webhook**フィールドの下、「**Test webhook**」をクリックします。
    
3.  フォームが表示されます。フィールドに入力し、「 **送信**」をクリックします。
    
4.  **テストフォーム提出**ダイアログを確認しましょう。そこにはフォームから送られるURL、ペイロード(転送されるデータ)、リクエストヘッダー(メッセージのフォーマット)が表示されます。
    
    > !注データにはコード行 "test": trueが含まれており、これによりテストデータと顧客データをフィルタリングできます。
    
    ![The Test Webhook page showing the payload.](https://doc.sitecore.com/api/markdown-image/sai/ja/users/sitecoreai/images/Forms_TestWebhook.jpg)
    
5.  **「送信**」をクリックします。
    

テストが成功したかどうかは通知メッセージで通知されます。

> !ヒント [プレビューモードで](https://doc.sitecore.com/sai/ja/users/sitecoreai/design-components/forms/saving-a-form/preview-your-form-design.html "Preview your form design")ウェブフックをテストすることもできます。

フォームの投稿が **ウェブフックから否定的な応答**を返す場合、それは次のことを意味します:

-   XM Cloudはペイロードを設定済みのウェブフックエンドポイントに正常に送信しました。
-   エンドポイントは応答しました(多くの場合HTTP 200)。
-   しかし、ウェブフックは失敗応答(isSuccessful: false)を返しました。

この場合、問題は通常ペイロード構造、受信端の検証エラー、またはフォームフィールドキーとWebhookの期待値の不一致に関連しています。

同様の問題を防ぐために:

-   一貫したフィールド命名規則を用いましょう。
-   フィールドキーにスペースや特殊文字は避けてください。
-   ウェブフックの検証ルールを文書化してください。
-   まずは最小限のペイロードで新しいフォームをテストしてください。
-   ウェブフックエンドポイントで詳細なログングを有効にしましょう。
-   展開前にペイロード構造を検証してください。
-   失敗したフォームと、動作するフォームをフィールドごとに比較してみましょう。

## ウェブフックを編集する

データの宛先URLが変わった場合は、ウェブフックを更新する必要があるかもしれません。

ウェブフックを編集するには:

1.  エディターでフォームを開き、エディターの上部メニューで **「設定**」をクリックします。
2.  **設定**ページの**「ウェブフック選択」の「ウェブフック管理**」をクリックします。
3.  **Webhooks**ページで、削除したいウェブフックに移動し、「**More** :mdiDotsHorizontal: > **Edit**」をクリックしてください。
4.  ウェブフックダイアログでは、以下の編集が可能です:
    -   **認証タイプ**
    -   **名称**
    -   **URL**
5.  **「送信**」をクリックします。

## ウェブフックを削除してください

> !注フォームで既に使用されていないウェブフックのみを削除できます。使用中のウェブフックはWebhooksページで「使用中」とマークされています。

ウェブフックを削除するには:

1.  エディターでフォームを開き、エディターの上部メニューで **「設定**」をクリックします。
2.  **設定**ページで**「ウェブフックの選択**」をクリックし、「**ウェブフックの管理**」をクリックします。
3.  **Webhooks**ページで削除したいWebhookに移動し、「**More** :mdiDotsHorizontal: > **Delete**」をクリックしてください。