Zum Hauptinhalt springen

Webhooks konfigurieren

Konfiguriere Webhooks in der Logto Console, um eine nahtlose Integration zu erreichen und Echtzeit-Benachrichtigungen über Ereignisse für deine Anwendung zu erhalten. Profitiere von einfacher Konfiguration, erhöhter Sicherheit und praktischen Optionen zur Überwachung des Zustands.

Webhook erstellen​

Erstelle zunächst einen Webhook-Endpunkt, der vom Logto Agent aufgerufen wird. Dieser Endpunkt sollte auf deinem Server implementiert sein und in der Lage sein, HTTP-Anfragen zu empfangen.

Um einen neuen Webhook in der Logto Console zu erstellen, folge diesen Schritten:

  1. Webhook erstellen: Navigiere zu Konsole > Webhooks und klicke auf die Schaltfläche „Webhook erstellen“.

  2. Name: Gib einen Namen für den Webhook an. Dieser dient deiner eigenen Referenz, um das Nutzungsszenario zu definieren.

  3. Endpunkt-URL: Gib die Endpunkt-URL ein, also die URL deines Servers, der die Webhook-POST-Anfragen erhält, wenn das Ereignis eintritt. Aus Sicherheitsgründen muss die URL öffentlich über HTTPS erreichbar sein und darf keine Localhost-URL sein.

    hinweis:

    Dein Server sollte auf die Logto-Webhook-Anfragen unmittelbar nach dem Empfang mit einer HTTP 200 („OK“)-Antwort reagieren, um zu signalisieren, dass die Anfrage empfangen wurde.

    Wenn du mit der Antwort wartest, bis die Logikverarbeitung des entsprechenden Webhook-Ereignisses abgeschlossen ist, kann dies zu einem Timeout des Webhooks führen.

    Gib keine andere Antwort als 200 an den Logto-Webhook zurück. Falls beim Verarbeiten des Ereignisses ein Fehler auftritt, behandle ihn auf deinem eigenen Server.

  4. Ereignis: Wähle im erscheinenden Modal die gewünschten Ereignisse aus, die diesen Webhook auslösen sollen. Es wird empfohlen, eine kleinere Anzahl von Ereignissen auszuwählen, die deinen Anforderungen entsprechen, um eine Überlastung des Servers zu vermeiden. Du kannst die ausgewählten Ereignisse jederzeit nach dem Erstellen des Webhooks ändern.

    Webhook erstellen

  5. Deaktivieren / Reaktivieren: Standardmäßig ist der Webhook unmittelbar nach der Erstellung aktiviert. Wenn du den Webhook vorübergehend aussetzen möchtest, kannst du ihn über das „Drei-Punkte“-Menü oben rechts in der Kopfzeile nach der Erstellung deaktivieren oder reaktivieren.

Webhook absichern​

Sobald dein Server bereit ist, Webhook-Anfragen zu empfangen, möchtest du sicherstellen, dass er diese Anfragen sicher verarbeiten kann. Logto generiert für jede Webhook-Anfrage eine Signatur, mit der du überprüfen kannst, ob die Anfrage tatsächlich von Logto stammt.

Nach dem Erstellen eines neuen Webhooks hast du folgende Möglichkeiten, die Sicherheit zu erhöhen:

  • Signierschlüssel: Logto generiert für jeden Webhook eine eindeutige Hash-Signatur, den sogenannten Signierschlüssel. Du kannst diesen Schlüssel als Request-Header in deiner Endpunkt-Implementierung einbinden. Die Überprüfung des Signierschlüssels stellt sicher, dass die Webhook-Nutzlast von Logto stammt und nicht von unbefugten Quellen manipuliert wurde. Lies Webhooks absichern, um mehr über den Code zu erfahren.
  • Benutzerdefinierter Header: Du hast die Möglichkeit, benutzerdefinierte Header in die Webhook-Nutzlast einzufügen, um zusätzlichen Kontext oder Metadaten bereitzustellen. Diese Funktion ermöglicht es dir, relevante Informationen hinzuzufügen, die bei der effektiven Verarbeitung der Webhook-Daten helfen können.

Durch die Verwendung des Signierschlüssels und das Hinzufügen benutzerdefinierter Header kannst du die Sicherheit deiner Webhooks erhöhen und die Integrität sowie Authentizität der empfangenen Nutzlasten sicherstellen.

Webhook testen​

Um die Verbindung zwischen Logto und deinen Diensten zu testen, klicke einfach auf die Schaltfläche „Testnutzlast senden“. Logto sendet dann für jedes ausgewählte Ereignis eine Beispiel-Nutzlast an deine Endpunkt-URL. Diese Testanfragen enthalten anonyme Daten und werden nicht im Verlauf der letzten Anfragen protokolliert.

Dieser Test stellt sicher, dass dein Webhook korrekt eingerichtet ist, um Nutzlasten von Logto zu empfangen und zu verarbeiten. So kannst du die Integration validieren, bevor du den Webhook in einer Live-Umgebung einsetzt.

Webhook-Gesundheitsstatus überwachen​

Logto bietet praktische Tools, um den Gesundheitsstatus deiner Webhooks zu überwachen und mögliche Probleme im Detail zu untersuchen:

  • Gesundheitsstatus Die Webhook-Liste in Logto zeigt den Gesundheitsstatus jedes Webhooks an, einschließlich der Erfolgsrate und der Gesamtzahl der Anfragen in den letzten 24 Stunden. Diese Informationen geben dir einen Überblick über die Leistung des Webhooks.
  • Unabhängige Anfrageprotokolle Im Abschnitt „Letzte Anfragen“ jedes Webhooks kannst du die Anfrageprotokolle der letzten 24 Stunden einsehen. Jede Anfrage wird einzeln protokolliert, sodass du die Details jeder Anfrage einsehen und mögliche Fehler oder Auffälligkeiten untersuchen kannst.
  • Automatische Wiederholung Im Falle einer fehlgeschlagenen Zustellung (wenn der Webhook-Antwortstatus größer oder gleich 500 ist), versucht Logto die Zustellung automatisch bis zu dreimal erneut. Mehrfache Wiederholungen derselben Anfrage erzeugen dabei nur einen einzigen Protokolleintrag, um unnötige Duplikate zu vermeiden. Alle Wiederholungen einer Anfrage tragen die gleiche deliveryId in der Nutzlast, sodass dein Endpunkt eine bereits verarbeitete Zustellung überspringen kann.

Mit diesen Überwachungsfunktionen kannst du den Zustand deiner Webhooks effektiv verfolgen, Anfrageprotokolle prüfen und die Zuverlässigkeit sowie Leistung deiner Webhook-Integrationen sicherstellen.