Zurück zum Hilfecenter

Schnittstelle (API)

Ereignisse per Webhook empfangen

Andere Systeme automatisch über Änderungen informieren.

Webhooks melden Ereignisse aus elyph aktiv an Ihr System — ohne Abfragen im Minutentakt. Typische Anwendungen sind das Anlegen von Aufgaben in einem Ticketsystem oder Meldungen in einen Chatkanal.

Für wen

IT und Integrationsverantwortliche.

Voraussetzungen

Bestehender API-Zugang Erreichbare HTTPS-Adresse

Einrichtung

  • Zieladresse — Öffentlich erreichbare HTTPS-Adresse Ihres Systems.
  • Ereignisse — Auswahl der Typen, etwa Maßnahme überfällig, Beurteilung freigegeben, Prüfung nicht bestanden.
  • Signaturgeheimnis — Wird bei der Einrichtung erzeugt; damit prüfen Sie die Echtheit jeder Zustellung.
  • Wiederholungen — Bei Fehlern wird mit wachsendem Abstand bis zu 24 Stunden erneut zugestellt.
  • Protokoll — Jede Zustellung mit Antwortcode, Dauer und Nutzlast einsehbar.

Ihr Empfänger sollte

  • die Signatur prüfen, bevor die Nutzlast verarbeitet wird — ungeprüfte Webhooks sind eine offene Tür;
  • sofort mit 2xx antworten und die Verarbeitung asynchron erledigen;
  • mit Wiederholungen umgehen können: Zustellungen sind mindestens einmal, gelegentlich mehrfach;
  • die Ereignis-ID zur Erkennung von Doppelungen verwenden.

Antwortet Ihr Ziel dauerhaft mit Fehlern, wird der Webhook automatisch pausiert und die Administration benachrichtigt.

Schritt für Schritt

  1. 1

    Ziel eintragen

    Adresse und Ereignisarten wählen, etwa Freigabe einer Beurteilung oder fehlgeschlagene Barrierenprüfung.

  2. 2

    Signatur prüfen

    Jede Zustellung ist signiert; prüfen Sie die Signatur, bevor Sie die Daten verarbeiten.

  3. 3

    Antworten

    Antworten Sie mit Status 2xx; andernfalls wiederholt elyph mit wachsendem Abstand.

  4. 4

    Zustellungen einsehen

    Die Liste zeigt Versuche, Antwortzeit und Fehler der letzten Tage.

Ergebnis

Ihre Systeme reagieren auf elyph-Ereignisse, ohne zu pollen.

Häufige Stolpersteine

  • Signatur nicht prüfen: Ihr Endpunkt ist sonst für Fremdaufrufe offen.

Häufige Fragen

Enthalten Webhooks vollständige Daten?
Sie enthalten Ereignistyp, Business-ID und die wichtigsten Felder. Vollständige Daten holen Sie anschließend über die Schnittstelle.

Verwandte Artikel