Webhook

Mit dem Webhook-Connector können Sie auf Ereignisse aus Ihrem Backend warten, das Webhooks unterstützt. Dieser Connector ist für die Verwendung mit dem Webhook-Trigger vorgesehen. Der Webhook-Trigger empfängt Ereignisse von SaaS-basierten Anwendungen von Drittanbietern, die Webhook-Ereignisse unterstützen. Dieser Trigger unterstützt mehrere Authentifizierungstypen für Ihren Ereignis-Listener. Wenn Sie den Webhook-Trigger in Ihrer Integration verwenden möchten, müssen Sie zuerst einen Webhook-Connector konfigurieren.

Hinweise

Führen Sie vor der Verwendung des Webhook-Connectors die folgenden Aufgaben aus:

  • In Ihrem Google Cloud-Projekt:
    • Aktivieren Sie die folgenden Dienste:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.

    • Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.

    Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.

Connector konfigurieren

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:

  1. Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.

    Zur Seite „Verbindungen“

  2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
  3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
    1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

    2. Klicken Sie auf Weiter.
  4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
    1. Connector: Wählen Sie Webhook aus der Drop-down-Liste der verfügbaren Connectors aus.
    2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
    3. Verbindungsname: Geben Sie einen Namen für die Verbindungsinstanz ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 49 Zeichen haben.
      • Bei Konnektoren, die Ereignisanmeldungen unterstützen, dürfen die Verbindungsnamen nicht mit dem Präfix „goog“ beginnen.
    4. Beschreibung: Geben Sie optional eine Beschreibung für die Verbindungsinstanz ein.
    5. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
    6. Ereignisabo: Das Ereignisabo ist standardmäßig aktiviert und für den Webhook-Connector erforderlich.
    7. Klicken Sie optional auf + Label hinzufügen, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    8. Klicken Sie auf Weiter.
  5. Führen Sie im Abschnitt Details zum Ereignisabo die folgenden Schritte aus:
    1. Listener-Authentifizierung: Wählen Sie einen Authentifizierungstyp für den Ereignis-Listener aus und geben Sie die erforderlichen Details ein.

      Die folgenden Authentifizierungstypen werden vom Webhook-Listener unterstützt:

    2. Ereignistyp – Feldspeicherort: Pflichtfeld, das den Speicherort (Header, Suchparameter oder Anfragekörper) angibt, an dem der Ereignistyp der eingehenden Ereignisanfrage vorhanden ist.
    3. Ereignistyp-Feldname: Dieses Feld ist im konfigurierten Speicherort obligatorisch und gibt den Ereignistyp an, der mit der eingehenden Ereignisanfrage verknüpft ist.
    4. {
      "event_type": "user.created",
      ...
      // other request fields
      ...
      }
      Im Beispiel oben gibt das Feld event_type im request body an, dass sich die Anfrage auf ein Ereignis vom Typ „user.created“ bezieht.
    5. Wählen Sie Private Verbindung aktivieren für eine sichere Verbindung zwischen Ihrer Backend-Anwendung und Ihrer Verbindung aus. Wenn Sie diese Option auswählen, müssen Sie nach dem Erstellen der Verbindung zusätzliche Konfigurationsschritte ausführen. Weitere Informationen finden Sie unter Private Verbindung für Ereignisabonnements.
    6. Geben Sie die Konfiguration für den Postfach-Alias ein. Wenn Sie ein Dead-Letter-Thema konfigurieren, schreibt die Verbindung die nicht verarbeiteten Ereignisse in das angegebene Pub/Sub-Thema. Geben Sie die folgenden Informationen ein:
      1. Dead-Letter-Projekt-ID : Die Google Cloud-Projekt-ID, in der Sie das Dead-Letter-Pub/Sub-Thema konfiguriert haben.
      2. Dead-Letter-Thema : Das Pub/Sub-Thema, in das Sie die Details des nicht verarbeiteten Ereignisses schreiben möchten.
    7. Klicken Sie auf Weiter.
  6. Überprüfen: Prüfen Sie Ihre Verbindungs- und Listener-Authentifizierungsdetails.
  7. Klicken Sie auf Erstellen.

Webhook-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung über die Connectors-Aufgabe in einer Integration verwenden.

  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors-Aufgabe.

Hilfe von der Google Cloud-Community erhalten

Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

Nächste Schritte