Webhooks

Webhooks sind automatische Benachrichtigungen per HTTP, die bei einem Ereignis in einer Anwendung ausgelöst werden. Sie ermöglichen die sofortige Datenübertragung an andere Systeme, ohne dass ständige Abfragen nötig sind, und eignen sich gut für Integrationen und Workflow-Automatisierungen.

Gehen Sie als Administrator in die Einstellungen Ihres Accounts. Unter dem Menüpunkt „Webhooks“ finden Sie die Auflistung bereist hinterlegter Webhooks und die Möglichkeit neue zu ergänzen.

Neue Webhooks erstellen:

Um einen neuen Webhook zu erstellen, klicken Sie bitte auf den Menüpunkt „Webhook erstellen“. Im folgenden können Sie dem Webhook einen beliebigen Namen geben. Dieser dient ausschließlich zu Ihrer Orientierung und hat keinen weiteren Einfluss auf den eigentlichen Webhook.

Als nächste geben Sie bitte an, für welche Kategorie Sie die entsprechenden Events empfangen wollen.

Beispiel:

  • Einzelne Kategorie: webinar.created → Ein Webinar wurde erstellt
  • Mehrere Kategorien: webinar.created, webinar.deleted → Webinar erstellt & gelöscht
  • Wildcard Kategorien: webinar.* → enthält zum beispiel webinar.created, webinar.updated, webinar.deleted

Damit der Webkook final eingerichtet werden kann müssen Sie im folgenden noch die Adresse des HTTP-Endpunkts ergänzen und die Einstellungen speichern.

Webhooks werden JSON serialisiert verschickt. Weitere Informationen zu JavaScript Object Notation finden Sie hier im Wikipedia Artikel.

In der Webhook Übersicht erkennen Sie direkt, ob es Fehler bei der Zustellung von einzelnen Webhooks gegeben hat.

  • Fehlgeschlagene Webhooks werden bis zu 24 Stunden lang versucht erneut zuzustellen. Erneute Zustellungen werden exponentiell verzögert
    • Erste Zustellung: Sofort
    • Zweite: Nach zwei Sekunden
    • Dritte: Nach vier Sekunden
    • Vierte: Nach acht Sekunden
    • Fünfte: Nach 16 Sekunden
    • etc.
    • 17. Zustellung: Nach 24h

Weitere Details zu den fehlgeschlagenen Zustellungen finden Sie wenn Sie den enstprechenden Webhook auswählen. Dort haben Sie auch die Möglichkeit die Zustellung manuell neu anzustoßen.

Dringender Sicherheitshinweis:

Webhooks können von jedem verschickt werden. Um sicherzustellen, dass edudip der Absender ist muss die Signatur überprüft werden. Wir nutzen HMAC für das Signieren der Daten im Payloads.

  • Jeder Webhook-Request enthält die folgenden relevanten HTTP-Header:
    • X-Edudip-Signature-Algorithm: Der Algorithmus, der zur Signatur verwendet wurde (z. B. SHA256).
    • X-Edudip-Signature: Die tatsächliche Signatur des Payloads, die zur Überprüfung benötigt wird.
  • Um die Signatur zu überprüfen:
    • Laden Sie den öffentlichen Schlüssel, der zu unserem privaten Schlüssel gehört. Diesen öffentlichen Schlüssel stellen wir bereit.
    • Hashen Sie den Payload des Webhooks mit dem Algorithmus aus dem X-Edudip-Signature-Algorithm-Header, um den Payload-Hash zu erhalten.
    • Nutzen Sie den öffentlichen Schlüssel, um die empfangene Signatur (X-Edudip-Signature) mit dem gehashten Payload zu vergleichen.

      Klicken Sie hier zum Download des Public Key