Webhooks

Webhooks sind Dienste, die Ihre Geschäftslogik hosten oder andere Dienste aufrufen. Während einer Sitzung können Sie mit Webhooks die Daten verwenden, die Dialogflow per Natural Language Processing extrahiert hat, um dynamische Antworten zu generieren, erfasste Daten zu validieren oder Aktionen im Backend auszulösen.

Ein Webhook kann entweder ein Standard-Webhook oder ein flexibler Webhook sein. Bei einem Standard-Webhook werden die Anfrage- und Antwortfelder von Dialogflow definiert. Bei einem flexiblen Webhook definieren Sie die Anfrage- und Antwortfelder.

Standard-Webhooks

Bei Standard-Webhooks verwenden Sie von Dialogflow definierte Anfrage- und Antwortnachrichten. Die Anfragenachricht enthält viele Details zur Sitzung. Dazu gehören z. B. die aktuelle aktive Seite, der zuletzt zugeordnete Intent, Sitzungsparameterwerte und vom Agent definierte Antworten.

Standard-Webhook-Anfrage

Wenn eine Auftragsausführung mit einem Webhook aufgerufen wird, sendet Dialogflow eine HTTPS-POST-Webhook-Anfrage an Ihren Webhook-Dienst. Der Text dieser Anfrage ist ein WebhookRequest-JSON-Objekt mit Informationen zur Sitzung.

Bei einigen Integrationen wird das Feld WebhookRequest.payload mit zusätzlichen Informationen ausgefüllt. Durch die Integration des Telefonie-Gateways von Dialogflow CX wird beispielsweise die Anrufer-ID des Endnutzers bereitgestellt.

Weitere Informationen finden Sie in der Referenzdokumentation zu WebhookRequest(V3) oder WebhookRequest(V3Beta1).

Standard-Webhook-Antwort

Sobald Ihr Webhook-Dienst eine Webhook-Anfrage empfängt, muss er eine Webhook-Antwort senden. Für die Antwort gelten die folgenden Einschränkungen:

  • Die Antwort muss innerhalb eines Zeitlimits auftreten, das Sie beim Erstellen der Webhook-Ressource konfigurieren. Andernfalls wird das Zeitlimit der Anfrage ausgelöst.
  • Die Antwort darf maximal 64 KiB groß sein.

Weitere Informationen finden Sie in der Referenzdokumentation zu WebhookResponse(V3) oder WebhookResponse(V3Beta1).

Einstellungen für Standard-Webhook-Ressourcen

Im Folgenden werden die Einstellungen für Webhook-Ressourcen für Standard-Webhooks beschrieben:

Begriff Definition
Anzeigename Der in der Konsole angezeigte Name des Webhooks.
Zeitlimit für Webhook Wenn Dialogflow eine Webhook-Anfrage an den Webhook-Dienst sendet, kann es zu einer Zeitüberschreitung kommen, während auf eine Antwort gewartet wird. Mit dieser Einstellung wird dieses Zeitlimit in Sekunden festgelegt. Wenn eine Zeitüberschreitung auftritt, ruft Dialogflow ein webhook.error.timeout-Ereignis auf.
Typ Legen Sie den Wert auf Service Directory fest, wenn Sie das Dienstverzeichnis für den privaten Netzwerkzugriff verwenden. Andernfalls wählen Sie Allgemeiner Webdienst aus.
Webhook-URL Geben Sie die URL-Adresse für Ihren Webhook-Dienst an.
Subtyp Auf Standard festlegen
Umgebungsspezifischer Webhook Sie können umgebungsspezifische Webhooks bereitstellen.
Authentifizierung Weitere Informationen finden Sie im Abschnitt Authentifizierung.
Benutzerdefiniertes CA-Zertifikat Damit können benutzerdefinierte CA-Zertifikate hochgeladen werden.

Flexible Webhooks

Bei flexiblen Webhooks definieren Sie die HTTP-Methode der Anfrage, die Anfrage-URL-Parameter und die Felder der Anfrage- und Antwortnachrichten. In der Anfrage können nur ausgewählte Parameterwerte angegeben werden und die Antwort kann nur Werte zur Parameterüberschreibung enthalten. Diese Einschränkung ist tatsächlich vorteilhaft, da sie die Schnittstelle zwischen dem Agent und dem Webhook vereinfacht. Zwischen einem Agent und einem Webhook ist ausschließlich die Kommunikation von Sitzungsparameterwerten erforderlich. Außerdem wird die Webhook-Implementierung vereinfacht, da die Anfrage- und Antwortnachrichten nur die benötigten Informationen enthalten und Sie für verschiedene Szenarien eindeutige Webhook-Nachrichten bereitstellen können.

Flexible Webhook-Anfrage

Wenn Sie die Webhook-Ressource für Ihren Agent erstellen, können Sie für Webhook-Anfragen Folgendes angeben:

  • Die HTTP-Methode für Webhook-Anfragen, die an Ihren Webhook-Dienst gesendet werden.
  • Sitzungsparameterwerte, die Dialogflow mithilfe der URL an Ihren Webhook-Dienst senden soll.
  • Wenn Sie POST, PUT oder PATCH als Methode auswählen, können Sie Sitzungsparameterwerte angeben, die Dialogflow über den JSON-Anfragetext an Ihren Webhook-Dienst senden soll.

Wenn Sie Sitzungsparameterwerte über die Anfrage-URL oder den JSON-Text senden möchten, verwenden Sie wie gewohnt Parameterverweise. Der Parameterverweis muss nicht URL-Escaping erfolgen und der Verweis muss nicht in Anführungszeichen gesetzt werden. Während der Laufzeit maskiert Dialogflow den Parameterwert nach Bedarf. Eine Liste oder ein zusammengesetzter Wert wird im JSON-Format bereitgestellt.

Wenn Sie einen Parameterverweis im JSON-Text verwenden, müssen Sie ihn in Anführungszeichen setzen, unabhängig vom Parametertyp. Wenn der Parameter tatsächlich ein numerischer Skalarwert, eine Liste oder ein zusammengesetzter Wert ist, entfernt Dialogflow die Anführungszeichen beim Senden der Anfrage zur Laufzeit, um den Datentyp des Parameters beizubehalten. Skalare Typen von Strings bleiben in Anführungszeichen. Wenn in einem Stringwert auf einen numerischen Skalarwert, eine Liste oder einen zusammengesetzten Wert verwiesen wird (z. B. "Dies ist eine Zahl: $session.params.size"), wird der Parameter als String behandelt ("Das ist eine Zahl: 3").

Sie können die Werte der Sitzungsparameter fruit und size beispielsweise so an die Anfrage-URL übergeben:

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

Fügen Sie dazu in den JSON-Text der Anfrage Folgendes ein:

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

Flexible Webhook-Antwort

Beim Erstellen der Webhook-Ressource für Ihren Agent können Sie Sitzungsparameter angeben, die Dialogflow zur Laufzeit auf bestimmte Felder der Webhook-Antwort festlegen soll.

Für die Antwort gelten die folgenden Einschränkungen:

  • Die Antwort muss innerhalb eines Zeitlimits auftreten, das Sie beim Erstellen der Webhook-Ressource konfigurieren. Andernfalls wird das Zeitlimit der Anfrage ausgelöst.
  • Die Antwort darf maximal 64 KiB groß sein.

Verwenden Sie das folgende Format, um ein Skalar-, Listen- oder zusammengesetztes Feld anzugeben:

$.fully.qualified.path.to.field

Betrachten Sie beispielsweise die folgende JSON-Antwort:

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

Verwenden Sie folgenden Code, um das Feld „value“ anzugeben:

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

Einstellungen für flexible Webhook-Ressourcen

Im Folgenden werden Webhook-Ressourceneinstellungen für flexible Webhooks beschrieben:

Begriff Definition
Anzeigename Der in der Konsole angezeigte Name des Webhooks.
Zeitlimit für Webhook Wenn Dialogflow eine Webhook-Anfrage an den Webhook-Dienst sendet, kann es zu einer Zeitüberschreitung kommen, während auf eine Antwort gewartet wird. Mit dieser Einstellung wird dieses Zeitlimit in Sekunden festgelegt. Wenn eine Zeitüberschreitung auftritt, ruft Dialogflow ein webhook.error.timeout-Ereignis auf.
Typ Legen Sie den Wert auf Service Directory fest, wenn Sie das Dienstverzeichnis für den privaten Netzwerkzugriff verwenden. Andernfalls wählen Sie Allgemeiner Webdienst aus.
Webhook-URL Geben Sie die URL-Adresse für Ihren Webhook-Dienst an, die Verweise auf Sitzungsparameter enthalten kann.
Subtyp Auf Flexibel festgelegt
Methode Legen Sie die HTTP-Methode für die Webhook-Anfrage fest.
Anfragetext Geben Sie den JSON-Anfragetext wie oben beschrieben an.
Antwortkonfiguration Geben Sie die Sitzungsparameter an, die auf Antwortfelder festgelegt werden sollen, wie oben beschrieben.
Umgebungsspezifischer Webhook Sie können umgebungsspezifische Webhooks bereitstellen.
Authentifizierung Weitere Informationen finden Sie im Abschnitt Authentifizierung.
Benutzerdefiniertes CA-Zertifikat Damit können benutzerdefinierte CA-Zertifikate hochgeladen werden.

Webhook-Dienstanforderungen

Der Webhook-Dienst muss die folgenden Anforderungen erfüllen:

Authentifizierung

Es ist wichtig, den Webhook-Dienst so zu sichern, dass nur Sie oder Ihr Dialogflow-Agent berechtigt sind, Anfragen zu stellen. Dies wird beim Erstellen einer Webhook-Ressource konfiguriert. Dialogflow CX unterstützt die folgenden Authentifizierungsverfahren:

Begriff Definition
Authentifizierungsheader Für Webhook-Einstellungen können Sie optionale HTTP-Header-Schlüssel/Wert-Paare angeben. Sofern angegeben, fügt Dialogflow diese HTTP-Header zu Webhook-Anfragen hinzu. Üblicherweise wird ein einzelnes Paar mit dem Schlüssel authorization angegeben. Die Headerwerte unterstützen Verweise auf Sitzungsparameter und das Parsing von Systemfunktionen wie in statischen Antwortnachrichten.
Basisauthentifizierung mit Nutzername und Passwort Für Webhook-Einstellungen können Sie optionale Anmeldedaten für den Nutzernamen und das Passwort angeben. Dialogflow fügt Webhook-Anfragen einen Autorisierungs-HTTP-Header hinzu, sofern angegeben. Dieser Header hat das Format "authorization: Basic <base 64 encoding of the string username:password>".
OAuth von Drittanbietern Sie können die OAuth-Konfiguration des Drittanbieters so festlegen, dass Dialogflow ein Zugriffstoken vom OAuth-Anbieter austauscht und dem Autorisierungs-HTTP-Header hinzufügt. Es wird nur der Vorgang für Client-Anmeldedaten unterstützt.
Zugriffstokens für den Dienst-Agent Sie können in der Authentifizierung des Dienst-Agents ein Zugriffstoken auswählen, um für die Authentifizierung Zugriffstokens für den Dienst-Agent zu verwenden. Dies kann für den Zugriff auf andere Google Cloud APIs verwendet werden.
Dienst-Agent-ID-Tokens Sie können ein ID-Token in der Dienst-Agent-Authentifizierung auswählen, um Dienst-Agent-ID-Tokens für die Authentifizierung zu verwenden. Damit können Sie auf Cloud Function- und Cloud Run-Dienste zugreifen. Wenn keine anderen Authentifizierungsoptionen verwendet werden, ist diese Option standardmäßig aktiviert.
Gegenseitige TLS-Authentifizierung Weitere Informationen finden Sie in der Dokumentation zur Gegenseitigen TLS-Authentifizierung.

HTTPS-Zertifikatsüberprüfung

Dialogflow verwendet standardmäßig den Standard-Trust Store von Google, um HTTPS-Zertifikate zu prüfen. Wenn Sie Zertifikate verwenden möchten, die vom Standard-Trust Store von Google nicht für Ihren HTTPS-Server erkannt werden, z. B. selbst signierte oder benutzerdefinierte Root-Zertifikate, lesen Sie die Informationen unter Benutzerdefinierte CA-Zertifikate.

Umgebungsspezifische Webhooks

Wenn Sie Umgebungen verwenden, um Produktionssysteme von Entwicklungssystemen zu isolieren (empfohlen), können Sie Ihre Webhooks als umgebungsspezifisch konfigurieren. Für jede von Ihnen definierte Webhook-Ressource können Sie eindeutige URL- und Authentifizierungseinstellungen für jede Umgebung angeben, die Sie für den Agent definiert haben.

So können Sie Aktualisierungen des Webhook-Codes sicher entwickeln und testen, bevor Sie sie für die Produktion bereitstellen.

Webhook-Ressourcen erstellen oder bearbeiten

Wenn ein Webhook-Dienst ausgeführt wird, müssen Sie in Ihrem Agent eine Webhook-Ressource mit Verbindungs- und Authentifizierungsinformationen erstellen. Nach dem Erstellen können Sie auch die Ressourceneinstellungen für Webhooks jederzeit bearbeiten.

So erstellen oder bearbeiten Sie eine Webhook-Ressource:

Console

  1. Öffnen Sie die Dialogflow CX Console.
  2. Wählen Sie Ihr Google Cloud-Projekt aus.
  3. Wählen Sie den Agent aus.
  4. Wählen Sie den Tab Verwalten.
  5. Klicken Sie auf Webhooks.
  6. Klicken Sie auf Erstellen oder in der Liste auf eine Webhook-Ressource, die Sie bearbeiten möchten.
  7. Geben Sie die Standardeinstellungen für Webhook-Ressourcen oder die Einstellungen für flexible Webhook-Ressourcen ein.
  8. Klicken Sie auf Speichern.

API

Informationen zum Erstellen einer Webhook-Ressource finden Sie in der Methode create für den Typ Webhook. Informationen zum Bearbeiten einer Webhook-Ressource (mit Ausnahme von umgebungsspezifischen Einstellungen) finden Sie in der Methode patch oder update für den Typ Webhook.

Wählen Sie ein Protokoll und eine Version für die Webhook-Referenz aus:

Protokoll V3 V3beta1
REST Webhook-Ressource Webhook-Ressource
RPC Webhook-Schnittstelle Webhook-Schnittstelle
C++ WebhooksClient Nicht verfügbar
C# WebhooksClient Nicht verfügbar
Einfach loslegen (Go) WebhooksClient Nicht verfügbar
Java WebhooksClient WebhooksClient
Node.js WebhooksClient WebhooksClient
PHP Nicht verfügbar Nicht verfügbar
Python WebhooksClient WebhooksClient
Ruby Nicht verfügbar Nicht verfügbar

Informationen zum Bearbeiten der umgebungsspezifischen Einstellungen für einen Webhook finden Sie in der Methode patch oder update für den Typ Environment.

Wählen Sie ein Protokoll und eine Version für die Umgebungsreferenz aus:

Protokoll V3 V3beta1
REST Umgebungsressource Umgebungsressource
RPC Umgebungsoberfläche Umgebungsoberfläche
C++ EnvironmentsClient Nicht verfügbar
C# EnvironmentsClient Nicht verfügbar
Einfach loslegen (Go) EnvironmentsClient Nicht verfügbar
Java EnvironmentsClient EnvironmentsClient
Node.js EnvironmentsClient EnvironmentsClient
PHP Nicht verfügbar Nicht verfügbar
Python EnvironmentsClient EnvironmentsClient
Ruby Nicht verfügbar Nicht verfügbar

Webhook-Fehler

Wenn Ihr Webhook-Dienst bei der Verarbeitung einer Webhook-Anfrage einen Fehler feststellt, muss Ihr Webhook-Code einen der folgenden HTTP-Statuscodes zurückgeben:

  • 400 Fehlerhafte Anfrage
  • 401 Nicht autorisiert
  • 403 Unzulässig
  • 404 Nicht gefunden
  • 500 Serverfehler
  • 503 Dienst nicht verfügbar

In allen folgenden Fehlersituationen ruft Dialogflow einen Webhook-Fehler oder ein integriertes Zeilimitereignis auf und fährt mit der Verarbeitung wie gewohnt fort:

  • Antwortzeitlimit überschritten.
  • Fehlerstatuscode empfangen.
  • Die Antwort ist ungültig.
  • Der Webhook-Dienst ist nicht verfügbar.

Wenn der Webhook-Dienstaufruf durch einen API-Aufruf zur Intent-Erkennung ausgelöst wurde, enthält das Feld queryResult.webhookStatuses in der Antwort zur Intent-Erkennung die Webhook-Statusinformationen.

Cloud Functions verwenden

Dialogflow lässt sich in Cloud Functions einbinden, sodass Sie problemlos einen sicheren, serverlosen Webhook erstellen können. Wenn Sie eine Funktion erstellen, die sich im selben Projekt wie Ihr Agent befindet, kann der Agent den Webhook ohne spezielle Konfiguration sicher aufrufen.

Es gibt jedoch zwei Situationen, in denen Sie diese Integration manuell einrichten müssen:

  1. Das Dienstkonto Dialogflow-Dienst-Agent mit der folgenden Adresse muss für Ihr Agent-Projekt vorhanden sein: 
    service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
    Dieses spezielle Dienstkonto und der zugehörige Schlüssel werden beim Erstellen des ersten Agents für ein Projekt normalerweise automatisch erstellt. Wenn Ihr Agent vor dem 1. November 2020 erstellt wurde, können Sie dieses spezielle Dienstkonto erstellen:
    1. Erstellen Sie einen neuen Agent für das Projekt.
    2. Führen Sie folgenden Befehl aus: 
      gcloud beta services identity create --service=dialogflow.googleapis.com --project=agent-project-id
  2. Wenn sich die Webhook-Funktion in einem anderen Projekt als der Agent befindet, müssen Sie den Cloud Functions-Invoker IAM-Rolle an die Dialogflow-Dienst-Agent Dienstkonto im Projekt Ihrer Funktion.

Containerisierte Webhooks und das Goezcx-Framework verwenden

Informationen zum Implementieren eines containerisierten Webhooks mit Go finden Sie im Go ezcx-Framework. Dieses Framework kann viele der Schritte beim Erstellen eines Webhooks vereinfachen.

Service Directory für den privaten Netzwerkzugriff verwenden

Dialogflow wird in privaten Service Directory-Zugriff eingebunden, sodass eine Verbindung zu Webhook-Zielen in Ihrem VPC-Netzwerk hergestellt werden kann. Dadurch wird der Traffic innerhalb des Google Cloud-Netzwerks beibehalten und IAM sowie VPC Service Controls erzwungen.

So richten Sie einen Webhook ein, der auf ein privates Netzwerk ausgerichtet ist:

  1. Folgen Sie der Anleitung unter Private Netzwerkkonfiguration für Service Directory, um Ihr VPC-Netzwerk und Ihren Service Directory-Endpunkt zu konfigurieren.

  2. Das Dienstkonto Dialogflow-Dienst-Agent mit der folgenden Adresse muss für Ihr Agent-Projekt vorhanden sein: 

    service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
    Gewähren Sie dem Dienstkonto Dialogflow-Dienst-Agent die folgenden IAM-Rollen:

    • servicedirectory.viewer des Service Directory-Projekts
    • servicedirectory.pscAuthorizedService des Netzwerkprojekts

  3. Geben Sie beim Erstellen des Webhooks den Service Directory-Dienst mit der URL und optionalen Authentifizierungsinformationen an.

    Console

    Screenshot: Service Directory-Webhook.

    API

    Weitere Informationen finden Sie im Feld serviceDirectory für den Typ Webhook.

    Wählen Sie ein Protokoll und eine Version für die Webhook-Referenz aus:

    Protokoll V3 V3beta1
    REST Webhook-Ressource Webhook-Ressource
    RPC Webhook-Schnittstelle Webhook-Schnittstelle
    C++ WebhooksClient Nicht verfügbar
    C# WebhooksClient Nicht verfügbar
    Einfach loslegen (Go) WebhooksClient Nicht verfügbar
    Java WebhooksClient WebhooksClient
    Node.js WebhooksClient WebhooksClient
    PHP Nicht verfügbar Nicht verfügbar
    Python WebhooksClient WebhooksClient
    Ruby Nicht verfügbar Nicht verfügbar

Zur Behebung von Problemen können Sie eine private Verfügbarkeitsdiagnose einrichten, um zu prüfen, ob Ihr Service Directory richtig konfiguriert ist.

Dienst-Agent-Authentifizierung

Dialogflow kann mit dem Dialogflow-Dienst-Agent ein ID-Token oder Zugriffstoken generieren.

Das Token wird dem Autorisierungs-HTTP-Header hinzugefügt, wenn Dialogflow einen Webhook aufruft.

ID-Token

Mit einem ID-Token kann auf Cloud Function- und Cloud Run-Dienste zugegriffen werden, nachdem Sie diesem Nutzer die Rolle „Invoker“ zugewiesen haben 

service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com
Wenn sich Cloud Function- und Cloud Run-Dienste im selben Ressourcenprojekt befinden, benötigen Sie keine zusätzliche IAM-Berechtigung, um sie aufzurufen.

Die Zielgruppe zum Generieren des ID-Tokens ist die gesamte Webhook-URL mit Ausnahme der Suchparameter. Wenn Sie Cloud Run verwenden, achten Sie darauf, dass diese URL von den Cloud Run-Zielgruppen unterstützt wird. Lautet die Webhook-URL beispielsweise

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

muss die folgende URL in benutzerdefinierten Zielgruppen enthalten sein.

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

Jeder Webhook kann das Token außerdem optional mithilfe von Google-Clientbibliotheken oder Open-Source-Bibliotheken wie github.com/googleapis/google-auth-library-nodejs validieren.

Zugriffstoken

Ein Zugriffstoken kann für den Zugriff auf andere Google Cloud APIs verwendet werden, nachdem Sie den 

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

Beispiele und Fehlerbehebung

Weitere Informationen finden Sie in der Anleitung für Webhooks.

Zurück
Auftragsausführungen
Weiter
Sprachmodelle