Definieren der Authentifizierungsmethode für Webhooks vor und nach der Nachricht

Dieses Dokument zeigt den Prozess zur Konfiguration der Authentifizierung für Pre-Message-Webhooks und Post-Message-Webhooks in watsonx Assistant. Er behandelt die verfügbaren Authentifizierungsmethoden und deren Einrichtung.

Übersicht

Webhooks ermöglichen es externen Systemen, mit watsonx Assistant zu kommunizieren. Die Authentifizierung stellt sicher, dass nur autorisierte Quellen Webhooks auslösen können. Diese Dokumentation beschreibt den Prozess zur Konfiguration und Verwaltung der Webhook-Authentifizierung, der eine aktualisierte Methode zur Authentifizierung von Webhooks einführt.

Vorbereitende Schritte

Bevor Sie die Webhook-Authentifizierung konfigurieren:

  • Sie müssen über Schreibrechte in der Umgebung verfügen.
  • Sie müssen über die Authentifizierungsdaten des Zielservers verfügen, einschließlich der URLs für die Token-Anforderung (falls erforderlich) und aller Geheimnisse, wie z. B. ein Kennwort oder ein Token.

Vorgehensweise

  1. Gehen Sie zu Home > Umgebungen.

  2. Wählen Sie das Zahnradsymbol „Einstellungen “ entweder auf der Registerkarte „Entwurf “ > „Entwurfsumgebung“ oder auf der Registerkarte „Live “ > „Live-Umgebung“ aus.

  3. Wählen Sie entweder Pre-Message Webhook oder Post-Message Webhook, je nachdem, was Sie definieren möchten.

  4. Blättern Sie nach unten zu Webhook-Einrichtung und fügen Sie die API URL ein.

  5. Klicken Sie auf Authentifizierung bearbeiten, um die Seite Authentifizierung einrichten zu öffnen.

  6. Wählen Sie in der Dropdown-Liste eine der folgenden Optionen:

  7. Klicken Sie auf Speichern.

Keine Authentifizierung

Dies ist die Standardoption.

Basisauthentifizierung

  1. Geben Sie einen Benutzernamen und ein Passwort ein.

Inhaber der Berechtigung

  1. Geben Sie den Überbringer-Token ein.

API-Schlüssel-Authentifizierung

  1. Geben Sie den API-Schlüsselnamen und den API-Schlüssel ein.

Unterzeichnet JWT

  1. Geben Sie das Geheimnis ein.
  2. Klicken Sie auf das Symbol Kennwort anzeigen , um das Geheimnis zu sehen.

OAuth 2.0

Wenn Sie die Zeichenfolge Scope verwenden, muss es sich um eine durch Leerzeichen begrenzte Menge von einem oder mehreren Authentifizierungsbereichen handeln, die vom Zielserver definiert wurden. Zum Beispiel Schreiben, Lesen+Schreiben, E-Mail-Lesen und so weiter.

  1. Wählen Sie unter Zuschussart eine der folgenden Optionen:

  2. Klicken Sie auf Speichern.

Kennwort

  1. Geben Sie den Benutzernamen Ihres Webhooks ein.

  2. Geben Sie das Passwort für Ihren Webhook-Dienst ein.

  3. Geben Sie die Client-ID für Ihren Webhook-Authentifizierungsdienst ein.

  4. Geben Sie das Client-Geheimnis ein, um Ihren Webhook zu authentifizieren.

  5. Geben Sie das Token URL ein.

  6. Geben Sie das Aktualisierungs-Token URL ein.

  7. Optional: Wenn Ihr Dienst eine Bereichszeichenfolge benötigt, geben Sie die vom Zielserver definierte Bereichszeichenfolge ein.

  8. Unter Client-Authentifizierung müssen Sie eine der folgenden Optionen wählen:

    • Als Basic Auth-Header senden: Die Authentifizierungsdaten werden im HTTP Header gesendet.
    • Als Body senden: Die Authentifizierungsdaten werden im Body der Anfrage gesendet.

  9. Geben Sie das Header-Präfix ein, zum Beispiel: Überbringer.

Clientberechtigungsnachweise

  1. Geben Sie die Client-ID für Ihren Webhook-Authentifizierungsdienst ein.

  2. Geben Sie das Client-Geheimnis ein, um Ihren Webhook zu authentifizieren.

  3. Geben Sie das Token URL ein.

  4. Geben Sie das Aktualisierungs-Token URL ein.

  5. Optional: Wenn Ihr Dienst eine Bereichszeichenfolge benötigt, geben Sie die vom Zielserver definierte Bereichszeichenfolge ein.

  6. Unter Client-Authentifizierung müssen Sie eine der folgenden Optionen wählen:

    • Als Basic Auth-Header senden: Die Authentifizierungsdaten werden im HTTP Header gesendet.
    • Als Body senden: Die Authentifizierungsdaten werden im Body der Anfrage gesendet.

  7. Geben Sie das Header-Präfix ein, zum Beispiel: Überbringer.

Autorisierungscode

  1. Geben Sie die Client-ID für Ihren Webhook-Authentifizierungsdienst ein.

  2. Geben Sie den autorisierenden Server URL ein.

  3. Geben Sie das Token URL ein.

  4. Geben Sie das Aktualisierungs-Token URL ein.

  5. Optional: Wenn Ihr Dienst eine Bereichszeichenfolge benötigt, geben Sie die vom Zielserver definierte Bereichszeichenfolge ein.

  6. Unter Client-Authentifizierung müssen Sie eine der folgenden Optionen wählen:

    • Als Basic Auth-Header senden: Die Authentifizierungsdaten werden im HTTP Header gesendet.
    • Als Body senden: Die Authentifizierungsdaten werden im Body der Anfrage gesendet.

  7. Geben Sie das Header-Präfix ein, zum Beispiel: Überbringer.

  8. Optional: Kopieren Sie je nach Zielserver die Redirect-URL in das Feld "Callback URL " Ihrer OAuth-App.

  9. Klicken Sie auf Zugriff gewähren.

  10. Führen Sie die Schritte auf der Seite aus, die der gewährende Server präsentiert.

  11. Sie werden zum Assistenten zurückgeleitet, und das Bearbeitungsfenster öffnet sich erneut.

  12. Geben Sie das Kundengeheimnis unter Kunden-ID ein, sobald das Feld sichtbar ist.

Angepasst

  1. Geben Sie den Namen des benutzerdefinierten Grant-Typs für Ihren Webhook ein.

  2. Geben Sie das Token URL ein.

  3. Geben Sie das Aktualisierungs-Token URL ein.

  4. Optional: Wenn Ihr Dienst eine Bereichszeichenfolge benötigt, geben Sie die vom Zielserver definierte Bereichszeichenfolge ein.

  5. Unter Client-Authentifizierung müssen Sie eine der folgenden Optionen wählen:

    • Als Basic Auth-Header senden: Die Authentifizierungsdaten werden im HTTP Header gesendet.
    • Als Body senden: Die Authentifizierungsdaten werden im Body der Anfrage gesendet.

  6. Geben Sie das Header-Präfix ein, zum Beispiel: Überbringer.

Wenn Sie Ihrer Anwendung benutzerdefinierte Geheimnisse hinzufügen müssen, gehen Sie folgendermaßen vor:

  1. Klicken Sie auf Geheimnis hinzufügen +.

  2. Geben Sie den Namen des Geheimnisses und den Wert des Geheimnisses ein.

  3. Optional: Wenn Sie weitere geheime Namen und geheime Werte hinzufügen möchten, klicken Sie auf Geheimnis hinzufügen +.

  4. Klicken Sie auf Parameter hinzufügen +.

  5. Geben Sie den Parameternamen und den Parameterwert ein.

  6. Optional: Wenn Sie weitere Parameternamen und Parameterwerte hinzufügen möchten, klicken Sie auf Parameter hinzufügen +.