Webhooks im Überblick
Mit Webhooks kann e-guma ein Drittsystem automatisch benachrichtigen, sobald bestimmte Ereignisse eintreten – zum Beispiel wenn ein Gutschein eingelöst oder eine Bestellung abgeschlossen wird. So bleiben angebundene Drittsysteme ohne Nachfragen auf dem aktuellen Stand.
In diesem Artikel
Was ist ein Webhook?
Ein Webhook ist eine automatische Benachrichtigung von e-guma an eine von Ihnen bereitgestellte Internet-Adresse (URL). Sobald ein bestimmtes Ereignis in e-guma stattfindet, sendet e-guma die zugehörigen Daten an diese URL.
Wie funktionieren Webhooks in e-guma?
- Sie (bzw. Ihr Integrationspartner) stellen eine URL bereit, die Webhook-Aufrufe entgegennehmen kann.
- Der e-guma Support hinterlegt diese URL für die gewünschten Ereignisse in Ihrem Mandanten.
- Tritt das Ereignis ein, sendet e-guma die Daten an Ihre URL.
- Ihre Anwendung bestätigt den Empfang mit einem erfolgreichen Statuscode und verarbeitet die Informationen weiter.
Kann Ihre URL den Aufruf nicht erfolgreich entgegennehmen, versucht e-guma den Versand insgesamt bis zu drei Mal. Technische Details zu Headers, Payload und Idempotenz finden Sie in unserer Dokumentation.
Welche Webhooks bietet e-guma an?
| Webhook (Topic) | Wird ausgelöst, wenn … |
|---|---|
voucher.redeemed |
ein Gutschein eingelöst wird |
voucher_order.created |
eine Gutscheinbestellung abgeschlossen wird |
voucher_type.created |
ein neuer Gutscheintyp angelegt wird |
voucher_type.updated |
ein bestehender Gutscheintyp geändert wird |
voucher_type.deleted |
ein Gutscheintyp gelöscht wird |
ticket_order.created |
eine Ticketbestellung abgeschlossen wird |
newsletter.opt_in_confirmed |
ein Kunde das Double-Opt-in für den Newsletter bestätigt |
Pro Ereignis können eine oder mehrere Empfänger-URLs hinterlegt werden. Die genaue Datenstruktur jedes Webhooks ist in der Dokumentation beschrieben.
Einrichtung
Webhooks werden nicht selbstständig in den Einstellungen aktiviert. Bitte senden Sie uns an support@e-guma.ch:
- die gewünschte Webhook-URL
- welche Ereignisse Sie benötigen
- den Namen Ihres e-guma Mandanten
Wir hinterlegen die Konfiguration und unterstützen Sie gerne beim ersten Test.
Monitoring und erneutes Auslösen durch den Support
Jeder Webhook-Versand wird in e-guma protokolliert. Schlägt der Versand nach den automatischen Wiederholungen fehl, wird unser Support benachrichtigt.
Unser Support kann im Webhook Log:
- den Status einzelner Lieferungen einsehen (pendent, erfolgreich, fehlgeschlagen)
- Request- und Antwortdaten prüfen
- fehlgeschlagene oder hängengebliebene Lieferungen bei Bedarf erneut auslösen
Falls Sie vermuten, dass eine Benachrichtigung bei Ihnen nicht angekommen ist, melden Sie sich bitte bei support@e-guma.ch. Wir prüfen den Versand und lösen ihn bei Bedarf erneut aus.