Webhook

Webhook は、ビジネスロジックのホストや、他のサービスの呼び出しを行うサービスです。Webhook では、セッション中に Dialogflow の自然言語処理で抽出されたデータを使用することで、動的レスポンスの生成、収集したデータの検証、バックエンドでのアクションのトリガーが可能になります。

Webhook は、標準 Webhook またはフレキシブル Webhook のいずれかになります。標準 Webhook では、リクエストフィールドとレスポンスフィールドは Dialogflow CX によって定義されます。フレキシブル Webhook では、リクエストフィールドとレスポンスフィールドを自分で定義します。

標準 Webhook

標準 Webhook では、Dialogflow CX で定義されたリクエストメッセージとレスポンスメッセージを使用します。リクエストメッセージには、セッションに関する多くの詳細情報が含まれています。たとえば、現在のアクティブなページ、最近一致したインテント、セッションパラメータ値、エージェント定義のレスポンスがすべて含まれています。

標準 Webhook リクエスト

Webhook でのフルフィルメントが呼び出されると、Dialogflow CX は Webhook サービスに HTTPS POST Webhook リクエストを送信します。このリクエストの本文は、セッションに関する情報を含む WebhookRequest JSON オブジェクトです。

一部の統合では、WebhookRequest.payload フィールドに追加情報が入力されます。たとえば、Dialogflow CX Phone Gateway の統合では、エンドユーザーの呼び出し元 ID を提供します。

詳しくは、WebhookRequest（V3）または WebhookRequest（V3Beta1）のリファレンスドキュメントをご覧ください。

標準 Webhook レスポンス

Webhook サービスは Webhook リクエストを受け取ると、Webhook レスポンスを送信する必要があります。回答には次の制限が適用されます。

レスポンスは、Webhook リソースを作成するときに構成したタイムアウト内で実行する必要があります。この制限時間を超えると、リクエストがタイムアウトになります。
レスポンスのサイズは 64 KiB 以下でなければなりません。

詳しくは、WebhookResponse（V3）または WebhookResponse（V3Beta1）のリファレンスドキュメントをご覧ください。

標準 Webhook リソース設定

標準 Webhook の Webhook リソース設定は次のとおりです。

用語	定義
表示名	Webhook のコンソールに表示される名前。
Webhook タイムアウト	Dialogflow CX が Webhook サービスに Webhook リクエストを送信する際、レスポンスの待機中にタイムアウトが発生することがあります。この設定では、タイムアウトを秒単位で制御します。タイムアウトが発生すると、Dialogflow CX によって webhook.error.timeout イベントが呼び出されます。
タイプ	プライベートネットワークアクセスに Service Directory を使用する場合は「Service Directory」、それ以外の場合は「Generic Web Service」に設定します。
webhook URL	Webhook サービスの URL アドレスを指定します。
サブタイプ	Standard に設定します。
環境特有の Webhook	環境特有の Webhook を指定できます。
認証	認証セクションをご覧ください。
カスタム CA 証明書	これはカスタム CA 証明書をアップロードするために使用されます。

フレキシブル Webhook

フレキシブル Webhook では、リクエスト HTTP メソッド、リクエスト URL パラメータ、リクエストメッセージとレスポンスメッセージのフィールドを自分で定義します。リクエストは、選択したパラメータ値のみを指定し、レスポンスはパラメータのオーバーライド値のみを指定できます。エージェントと Webhook 間のインターフェースを簡素化するため、この制限は実際に有益です。エージェントと Webhook 間でセッションパラメータ値以外の通信を行う必要はほとんどありません。また、リクエストメッセージとレスポンスメッセージには必要なものだけが含まれ、さまざまなシナリオに一意の Webhook メッセージを指定できるため、Webhook の実装も簡素化されます。

フレキシブル Webhook リクエスト

エージェントの Webhook リソースを作成する際に、Webhook リクエストに対し、以下を指定できます。

Webhook サービスに送信される Webhook リクエストに使用される HTTP メソッド。
Dialogflow CX が URL を使用して Webhook サービスに送信するセッションパラメータ値。
方式として POST、PUT、PATCH のいずれかを選択した場合、リクエストの JSON 本文を通じて Dialogflow CX が Webhook サービスに送信するセッションパラメータ値を指定できます。

リクエスト URL または JSON 本文を使用してセッションパラメータ値を送信するには、通常どおりパラメータ参照を使用します。パラメータ参照を URL エスケープする必要はありません。また、参照を引用符で囲む必要はありません。実行時に、Dialogflow CX は必要に応じてパラメータ値を URL エスケープします。リストまたは複合値は JSON として指定されます。

JSON 本文でパラメータ参照を使用する場合は、パラメータのタイプに関係なく、参照を引用符で囲む必要があります。パラメータが実際に数値スカラー、リスト、複合値である場合、Dialogflow CX は、実行時にリクエストを送信するときに引用符を削除して、パラメータのデータ型を保持します。文字列スカラー型は、引用符で囲まれたままになります。数値スカラー、数値、または複合値が文字列値内で参照されている場合（例: "This is a number: $session.params.size"）、パラメータは文字列として扱われます（"This is a number: 3"）。

たとえば、次のようにして、fruit と size のセッションパラメータ値をリクエスト URL に指定できます。

https://your-webhook-service.com/handler?f=$session.params.fruit&s=$session.params.size

また、次のようにして、リクエスト JSON 本文に指定できます。

{
  "fruitParameter": "$session.params.fruit",
  "sizeParameter": "$session.params.size"
}

フレキシブル Webhook レスポンス

エージェントの Webhook リソースを作成する際に、Dialogflow CX が実行時に Webhook レスポンスの特定のフィールドに設定する必要があるセッションパラメータを指定できます。

回答には次の制限が適用されます。

レスポンスは、Webhook リソースを作成するときに構成したタイムアウト内で実行する必要があります。この制限時間を超えると、リクエストがタイムアウトになります。
レスポンスのサイズは 64 KiB 以下でなければなりません。

スカラー、リスト、複合フィールドを指定するには、次の形式を使用します。

$.fully.qualified.path.to.field

たとえば、次の JSON レスポンスについて考えてみましょう。

{
  "routes" : [
    {
      "legs" : [
        {
          "distance" : {
            "text" : "2,064 mi",
            "value" : 3321004
          }
        }
      ]
    }
  ]
}

「value」フィールドを指定するには、次のコマンドを使用します。

$.routes[0].legs[0].distance.value

フレキシブル Webhook リソース設定

フレキシブル Webhook の Webhook リソース設定は次のとおりです。

用語	定義
表示名	Webhook のコンソールに表示される名前。
Webhook タイムアウト	Dialogflow CX が Webhook サービスに Webhook リクエストを送信する際、レスポンスの待機中にタイムアウトが発生することがあります。この設定では、タイムアウトを秒単位で制御します。タイムアウトが発生すると、Dialogflow CX によって webhook.error.timeout イベントが呼び出されます。
タイプ	プライベートネットワークアクセスに Service Directory を使用する場合は「Service Directory」、それ以外の場合は「Generic Web Service」に設定します。
webhook URL	Webhook サービスの URL アドレスを指定します。これには、セッションパラメータへの参照を配置することができます。
サブタイプ	フレキシブルに設定します。
メソッド	Webhook リクエストの HTTP メソッドを設定します。
リクエストの本文	前述のように、リクエストの JSON 本文を指定します。
レスポンスの構成	前述のように、レスポンスフィールドに設定する必要があるセッションパラメータを指定します。
環境特有の Webhook	環境特有の Webhook を指定できます。
認証	認証セクションをご覧ください。
カスタム CA 証明書	これはカスタム CA 証明書をアップロードするために使用されます。

事前定義されたカスタムテンプレートを使用する

Dialogflow には、柔軟な Webhook を Salesforce CRM と統合するために使用できる、事前定義されたカスタムテンプレートが用意されています。

[管理] タブで、[Webhooks]、[+ 作成] の順にクリックします。
[サブタイプ] で [フレキシブル] を選択します。
[事前定義されたテンプレートを使用して構成] をクリックして、この機能を有効にします。
[統合タイプ] プルダウンメニューで、[Salesforce] を選択します。
[API 名] プルダウンメニューで API 名を選択します。テンプレートでは、選択した API 名に基づいて Webhook フォームが自動的に入力されます。
1. 必要に応じて、パラメータに基づいて次のフィールドを手動で構成できます。
  - webhook URL
  - メソッド
  - リクエスト本文の JSON
  - レスポンスの構成
2. 必要な OAuth フィールドは、[認証] セクションでハイライト表示されます。
[保存] をクリックして、Webhook を作成します。

Webhook サービスの要件

webhook サービスは、次の要件を満たす必要があります。

HTTPS リクエストを処理する必要があります。HTTP はサポートされていません。コンピューティングまたはサーバーレスコンピューティングソリューションを使用して Google Cloud Platform で Webhook サービスをホストしている場合は、HTTPS によるサービス提供に関するドキュメントをご覧ください。その他のホスティングオプションについては、ドメインの SSL 証明書を取得するをご覧ください。
リクエストの URL は、Cloud Run functions の関数としてホストされている場合、または Service Directory Webhook としてアクセスされている場合を除き、公開アクセス可能である必要があります。
標準 Webhook またはフレキシブル Webhook セクションで説明されているとおりに、リクエストとレスポンスを処理する必要があります。
エージェントが Service Directory のプライベートネットワークアクセスと統合されていない場合、Webhook 呼び出しはサービス境界外とみなされ、VPC Service Controls を有効にするときにブロックされます。制限付きエンドポイントは Service Directory でサポートされています。詳細については、Service Directory をご覧ください。

認証

Dialogflow CX エージェントまたはその所有者のみがリクエスト作成認証を持つように、Webhook サービスを保護することが重要です。これは Webhook リソースを作成するときに構成されます。Dialogflow CX は次の認証メカニズムをサポートしています。

用語	定義
認証ヘッダー	Webhook の設定では、オプションの HTTP ヘッダーの Key-Value ペアを指定できます。指定した場合、Dialogflow CX によって Webhook リクエストに HTTP ヘッダーが追加されます。通常は、`authorization` のキーを持つ単一のペアを指定します。ヘッダー値は、静的レスポンスメッセージの場合と同様に、セッションパラメータ参照とシステム関数の解析をサポートしています。
ユーザー名とパスワードによる基本認証	Webhook の設定では、必要に応じてログインユーザー名とパスワードの値を指定できます。指定された場合、Dialogflow CX は webhook リクエストに認証 HTTP ヘッダーを追加します。このヘッダーの形式は `"authorization: Basic <base 64 encoding of the string username:password>"` です。
サードパーティの OAuth	Dialogflow CX が OAuth プロバイダからのアクセストークンを交換して認証 HTTP ヘッダーに追加するように、サードパーティの OAuth 構成を指定できます。クライアント認証情報フローのみがサポートされています。
サービスエージェントのアクセストークン	サービスエージェント認証でアクセストークンを選択して、認証にサービスエージェントのアクセストークンを使用できます。これを使用して、他の Google Cloud APIs にアクセスできます。
サービスエージェントの ID トークン	サービスエージェント認証で ID トークンを選択して、認証にサービスエージェントの ID トークンを使用できます。これを使用して、Cloud Run functions と Cloud Run サービスにアクセスできます。
相互 TLS 認証	相互 TLS 認証のドキュメントをご覧ください。

HTTPS 証明書の検証

Dialogflow CX はデフォルトで Google のデフォルトのトラストストアを使用して HTTPS 証明書を検証します。Google のデフォルトのトラストストアで認識されない証明書（自己署名証明書やカスタムルート証明書など）を HTTPS サーバーに使用する場合は、カスタム CA 証明書をご覧ください。

環境特有の Webhook

環境を使用して本番環境システムを開発環境から分離している場合は（推奨）、Webhook を環境特有に構成できます。定義した Webhook リソースごとに、エージェント用に定義した環境ごとに一意の URL と認証の設定を指定できます。

これによって、Webhook コードの更新を本番環境にデプロイする前に安全に開発してテストできます。

Webhook リソースを作成または編集する

Webhook サービスを実行すると、接続と認証の情報を含むエージェントに Webhook リソースを作成する必要があります。作成後、Webhook リソースの設定を随時編集することもできます。

Webhook リソースを作成または編集するには:

コンソール

Dialogflow CX Console を開きます。
ご自身の Google Cloud プロジェクトを選択します。
エージェントを選択します。
[Manage] タブを選択します。
[Webhooks] をクリックします。
[作成] をクリックするか、編集するリスト内の Webhook リソースをクリックします。
標準の Webhook リソース設定またはフレキシブル Webhook リソース設定を入力します。
[保存] をクリックします。

API

Webhook リソースを作成するには、Webhook タイプ用の create メソッドをご覧ください。Webhook リソース（環境特有の設定を除く）を編集するには、Webhook タイプ用の patch または update メソッドをご覧ください。

Webhook リファレンスのプロトコルとバージョンを選択:

プロトコル	V3	V3beta1
REST	Webhook リソース	Webhook リソース
RPC	Webhook インターフェース	Webhook インターフェース
C++	WebhooksClient	利用できません
C#	WebhooksClient	利用できません
Go	WebhooksClient	利用できません
Java	WebhooksClient	WebhooksClient
Node.js	WebhooksClient	WebhooksClient
PHP	利用不可	利用できません
Python	WebhooksClient	WebhooksClient
Ruby	利用不可	利用できません

Webhook 用の環境特有の設定を編集するには、Environment タイプ用の patch または update メソッドをご覧ください。

環境リファレンスのプロトコルとバージョンを選択:

プロトコル	V3	V3beta1
REST	環境リソース	環境リソース
RPC	環境インターフェース	環境インターフェース
C++	EnvironmentsClient	利用できません
C#	EnvironmentsClient	利用できません
Go	EnvironmentsClient	利用できません
Java	EnvironmentsClient	EnvironmentsClient
Node.js	EnvironmentsClient	EnvironmentsClient
PHP	利用不可	利用できません
Python	EnvironmentsClient	EnvironmentsClient
Ruby	利用不可	利用できません

Webhook エラー

Webhook サービスで Webhook リクエストの処理中にエラーが発生した場合、Webhook コードは次のいずれかの HTTP ステータスコードを返します。

400 Bad Request（不正なリクエスト）
401 Unauthorized（未承認）
403 Forbidden（禁止）
404 Not found（未検出）
500 Server fault（サーバーエラー）
503 Service Unavailable（サービス利用不可）

エラー状況が次のいずれかの場合、Dialogflow CX は Webhook エラーまたはタイムアウトの組み込みイベントを呼び出し、通常どおり処理を続けます。

レスポンスのタイムアウトを超過しました。
エラーステータスコードを受信しました。
レスポンスが無効です。
Webhook サービスを利用できません。

また、インテント検出 API 呼び出しによってWebhook サービス呼び出しがトリガーされた場合、インテント検出レスポンスの queryResult.webhookStatuses フィールドには Webhook ステータスの情報が含まれます。

Cloud Run functions の使用

Dialogflow CX は Cloud Run functions と統合されているため、セキュアなサーバーレス Webhook を簡単に作成できます。エージェントと同じプロジェクトに存在する関数を作成する場合、認証構成で [サービスエージェント認証 -> ID トークン] を選択するだけで、エージェントは Webhook を安全に呼び出すことができます。

ただし、次の 2 つの状況では、この統合を手動で設定する必要があります。

次のアドレスを含む Dialogflow CX サービスエージェントのサービスアカウントが、エージェントプロジェクト用に存在している必要があります。
```
service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
```
この特別なサービスアカウントおよび関連付けられた鍵は通常、プロジェクトの最初のエージェントを作成するときに自動的に作成されます。2020 年 11 月 1 日より前にエージェントを作成した場合は、この特別なサービスアカウントの作成をトリガーできます。
1. プロジェクトの新しいエージェントを作成します。
2. 次のコマンドを実行します。
```
gcloud beta services identity create --service=dialogflow.googleapis.com --project=agent-project-id
```
Webhook 関数がエージェントとは異なるプロジェクトにある場合は、関数のプロジェクトのDialogflow CX Service Agent サービスアカウントに Cloud Functions 起動元の IAM のロールを提供する必要があります。
[認証構成] セクションで、[サービスエージェント認証 -> ID トークン] を選択します。

コンテナ化された Webhook と Go ezcx フレームワークの使用

Go を使用してコンテナ化された Webhook を実装する場合は、Go ezcx フレームワークをご覧ください。このフレームワークを使用すると、Webhook の作成に必要な多くの手順を簡素化できます。

内部トラフィック専用の Cloud Run functions の使用

同じプロジェクトまたは同じ VPC SC 境界内の VPC ネットワークからの内部トラフィックを受け入れるように設定された Cloud Run functions は、エージェントが同じプロジェクトまたは同じ VPC SC 境界内にある限り、Webhook として使用できます。

サービスディレクトリを使用したプライベートネットワークアクセス

Dialogflow CX は Service Directory プライベートネットワークアクセスと統合されたため、VPC ネットワーク内の Webhook ターゲットに接続できます。これにより、トラフィックが Google Cloud ネットワーク内に保持され、IAM と VPC Service Controls が適用されます。

プライベートネットワークをターゲットとする Webhook を設定するには、次のようにします。

サービスディレクトリのプライベートネットワーク構成に従って、VPC ネットワークとサービスディレクトリエンドポイントを構成します。

注: Dialogflow CX は Service Directory の情報を 90 秒間キャッシュに保存します。つまり、Service Directory エンドポイントを更新する場合は、変更が反映されるまでに 90 秒かかります。また、冗長性のために複数のエンドポイントを設定している場合に、Dialogflow CX が障害が発生したエンドポイント経由で 90 秒間トラフィックを送信する可能性があります。
次のアドレスを含む Dialogflow CX サービスエージェントのサービスアカウントが、エージェントプロジェクト用に存在している必要があります。
```
service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
```
Dialogflow CX サービスエージェントのサービスアカウントに、次の IAM ロールを付与します。
- サービスディレクトリプロジェクトの servicedirectory.viewer
- ネットワークプロジェクトの servicedirectory.pscAuthorizedService

Webhook の作成時に、サービスディレクトリサービスと URL、オプションの認証情報を指定します。

コンソール

サービスディレクトリ Webhook のスクリーンショット。

API

Webhook タイプの serviceDirectory フィールドをご覧ください。

Webhook リファレンスのプロトコルとバージョンを選択:

プロトコル	V3	V3beta1
REST	Webhook リソース	Webhook リソース
RPC	Webhook インターフェース	Webhook インターフェース
C++	WebhooksClient	利用できません
C#	WebhooksClient	利用できません
Go	WebhooksClient	利用できません
Java	WebhooksClient	WebhooksClient
Node.js	WebhooksClient	WebhooksClient
PHP	利用不可	利用できません
Python	WebhooksClient	WebhooksClient
Ruby	利用不可	利用できません

問題のトラブルシューティングを行う場合、非公開稼働時間チェックを設定することで Service Directory が正しく構成されていることを確認できます。

サービスエージェントの認証

Dialogflow CX は、Dialogflow CX サービスエージェントを使用して、ID トークンまたはアクセストークンを生成できます。

トークンは、Dialogflow CX が Webhook を呼び出すときに認可 HTTP ヘッダーに追加されます。

ID トークン

呼び出し元のロールを付与すると、ID トークンを使用して Cloud Run functions と Cloud Run サービスにアクセスできます。

service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com

Cloud Run functions と Cloud Run のサービスが同じリソースプロジェクト内にある場合、これらを呼び出すための追加の IAM 権限は必要ありません。

ID トークンの生成に使用されるオーディエンスは、クエリパラメータ以外の Webhook URL 全体になります。Cloud Run を使用している場合は、この URL が Cloud Run オーディエンスでサポートされていることを確認してください。たとえば、Webhook URL が

https://myproject.cloudfunctions.net/my-function/method1?query=value

の場合、次の URL をカスタムオーディエンスに含める必要があります。

https://myproject.cloudfunctions.net/my-function/method1

Webhook はまた、Google クライアントライブラリまたは github.com/googleapis/google-auth-library-nodejs などのオープンソースライブラリを使用して、必要に応じてトークンを検証できます。

アクセストークン

アクセストークンを使用して、必要なロールを付与した後、その他の Google Cloud APIs にアクセスできます。

service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com

サンプルとトラブルシューティング

Webhook の入門ガイドをご覧ください。

フルフィルメント

生成ツール

Webhook

標準 Webhook

標準 Webhook リクエスト

標準 Webhook レスポンス

標準 Webhook リソース設定

フレキシブル Webhook

フレキシブル Webhook リクエスト

フレキシブル Webhook レスポンス

フレキシブル Webhook リソース設定

事前定義されたカスタム テンプレートを使用する

Webhook サービスの要件

認証

HTTPS 証明書の検証

環境特有の Webhook

Webhook リソースを作成または編集する

コンソール

API

Webhook エラー

Cloud Run functions の使用

コンテナ化された Webhook と Go ezcx フレームワークの使用

内部トラフィック専用の Cloud Run functions の使用

サービス ディレクトリを使用したプライベート ネットワーク アクセス

コンソール

API

サービス エージェントの認証

ID トークン

アクセス トークン

サンプルとトラブルシューティング

事前定義されたカスタムテンプレートを使用する

サービスディレクトリを使用したプライベートネットワークアクセス

サービスエージェントの認証

アクセストークン