Zum Hauptinhalt springen

Webhooks konfigurieren

Konfiguriere Webhooks in der Logto-Konsole, um nahtlose Integration zu erreichen und Echtzeit-Benachrichtigungen für deine Anwendung zu erhalten. Genieße einfache Konfiguration, verbesserte Sicherheit und bequeme Optionen zur Gesundheitsüberwachung.

Erstelle einen Webhook​

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-Konsole 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. Er dient deiner eigenen Referenz zur Definition des Nutzungsszenarios.

  3. Endpoint URL: Gib die Endpoint URL ein, die die URL deines Servers ist, der die Webhook-POST-Anfragen empfängt, wenn das Ereignis eintritt. Aus Sicherheitsgründen muss die URL öffentlich über HTTPS zugänglich sein und sollte keine lokale Host-URL sein.

    hinweis

    Dein Server sollte auf die Logto-Webhook-Anfragen mit einer HTTP 200 ("OK") Antwort direkt nach dem Empfang der Anfrage antworten, um zu bestätigen, dass die Anfrage empfangen wurde.

    Das Warten auf die Fertigstellung der Logikverarbeitung des entsprechenden Webhook-Ereignisses, bevor geantwortet wird, könnte dazu führen, dass der Webhook ein Timeout erhält.

    Gib keine andere Antwort als 200 an den Logto-Webhook zurück. Wenn ein Fehler bei der Verarbeitung des Ereignisses auftritt, bearbeite ihn auf deinem eigenen Server.

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

    Webhook erstellen

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

Webhook sichern​

Sobald dein Server bereit ist, Webhook-Anfragen zu empfangen, möchtest du sicherstellen, dass er die Anfragen sicher verarbeiten kann. Logto generiert eine Signatur für jede Webhook-Anfrage-Payload, die es dir ermöglicht zu überprüfen, dass die Anfrage von Logto stammt.

Nach der Erstellung eines neuen Webhooks hast du Optionen, um seine Sicherheit zu erhöhen:

  • Signaturschlüssel: Logto generiert eine eindeutige Hash-Signatur, bekannt als Signaturschlüssel, für jeden Webhook. Du kannst diesen Schlüssel als Anforderungsheader in deiner Endpunktimplementierung einfügen. Die Überprüfung des Signaturschlüssels stellt sicher, dass die Webhook-Payload von Logto stammt und nicht von unbefugten Quellen manipuliert wurde. Lies Sicherung deiner Webhooks, um mehr über den Code zu erfahren.
  • Benutzerdefinierter Header: Du hast die Möglichkeit, benutzerdefinierte Header in die Webhook-Payload 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 Nutzung des Signaturschlüssels und die Berücksichtigung der Einbeziehung benutzerdefinierter Header kannst du die Sicherheit deiner Webhooks erhöhen und die Integrität und Authentizität der empfangenen Payloads sicherstellen.

Webhook testen​

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

Dieser Test stellt sicher, dass dein Webhook ordnungsgemäß eingerichtet ist, um Payloads von Logto zu empfangen und zu verarbeiten. Er ermöglicht es dir, die Integration zu validieren, bevor du den Webhook in einer Live-Umgebung einsetzt.

Überwache den Gesundheitsstatus des Webhooks​

Logto bietet praktische Tools zur Überwachung des Gesundheitsstatus deiner Webhooks und zur detaillierten Untersuchung potenzieller Probleme:

  • Gesundheitsstatus Die Webhook-Liste in Logto zeigt den Gesundheitsstatus jedes Webhooks an, einschließlich der Erfolgsrate und der Gesamtanzahl der Anfragen in den letzten 24 Stunden. Diese Informationen geben dir einen Überblick über die Leistung des Webhooks.
  • Unabhängige Anforderungsprotokolle Im Abschnitt "Letzte Anfragen" jedes Webhooks kannst du auf die Anforderungsprotokolle der letzten 24 Stunden zugreifen. Jede Anfrage wird einzeln protokolliert, sodass du die Details jeder Anfrage einsehen und potenzielle Fehler oder Anomalien untersuchen kannst.
  • Automatisches Wiederholen Im Falle einer fehlgeschlagenen Zustellung (wenn der Webhook-Antwortstatus größer oder gleich 500 ist) versucht Logto automatisch, die Zustellung bis zu dreimal zu wiederholen. Sei versichert, dass mehrere Wiederholungen derselben Anfrage nur einen einzigen Protokolleintrag erzeugen, um unnötige Duplikate zu vermeiden.

Durch die Nutzung dieser Überwachungsfunktionen kannst du den Gesundheitszustand deiner Webhooks effektiv verfolgen, Anforderungsprotokolle untersuchen und die Zuverlässigkeit und Leistung deiner Webhook-Integrationen sicherstellen.