Was ist ein Webhook? #
Webhooks ergänzen die QRmaint-API und ermöglichen den automatisierten Informationsaustausch zwischen dem QRmaint-System und externen Systemen (z. B. der Serveranwendung des Clients).
Während die QRmaint-API auf Pull-Kommunikation basiert – der Client fragt aktiv Informationen ab – arbeiten Webhooks per Push: Sie senden automatisch Informationen, sobald ein bestimmtes Ereignis im QRmaint-Clientkonto auftritt. Dadurch können externe Systeme sofort reagieren, ohne ständig nach neuen Daten fragen zu müssen.
Das zentrale Element eines Webhooks ist ein Ereignis. Ein Ereignis kann z. B. das Anlegen einer neuen Meldung oder das Ändern des Auftragsstatus sein. Der Client legt fest, für welche Ereignisse er informiert werden möchte.
Sobald ein festgelegtes Ereignis eintritt, sendet das QRmaint-System eine HTTP-Anfrage an die vom Client definierte URL. Diese Anfrage enthält einen Nachrichteninhalt (Payload) mit allen relevanten Informationen zum Ereignis – z. B.:
- EventTypeId – Kennung des Ereignistyps
- WorkId – ID des Auftrags (falls zutreffend)
- PreviousStatusId / NewStatusId – alter und neuer Status eines Auftrags
- RequestId – eindeutige ID der Anfrage für die Nachverfolgung
Derzeit können im QRmaint-System folgende Ereignistypen von Webhooks weitergeleitet werden:
- Hinzufügen einer neuen Meldung
- Hinzufügen eines neuen Auftrags
- Ändern des Auftragsstatus
Hinweis: Webhooks sind eine praktische Ergänzung zu APIs. Sie ermöglichen eine schnelle, automatische Datenübertragung, ohne dass der Client ständig Informationen abfragen muss. Gleichzeitig enthalten sie strukturierte Daten, die direkt von externen Anwendungen verarbeitet werden können.
