Was ist ein Webhook?
Ein Webhook ist eine automatische Nachricht, die unser System an eine andere Anwendung sendet, wenn etwas Wichtiges passiert, zum Beispiel wenn eine Rechnung erstellt oder rückgängig gemacht wird. Du erhältst diese Benachrichtigungen sofort und kannst in Echtzeit reagieren.
Damit kannst du:
Rechnungen mit Buchhaltungstools synchronisieren
Automationen auslösen
Externe Systeme in Echtzeit aktuell halten
Hinweis: Webhooks erfordern eine technische Einrichtung und sind keine Plug-and-Play-Funktion. Stelle sicher, dass du über Kenntnisse in der Softwareentwicklung verfügst, bevor du diese Anleitung vollständig durchgehst.
Bevor du beginnst
Um Invoice Webhooks zu verwenden, brauchst du einen sicheren HTTPS-Endpunkt (URL), der POST-Anfragen mit JSON-Daten empfangen kann.
Schritt-für-Schritt-Anleitung
Sobald dein Endpunkt bereit ist, gehe zu https://backoffice.bsport.io/settings/webhook.
Klicke auf die Schaltfläche "Add a webhook"
Wähle das Ereignis aus, das du abonnieren möchtest (Ereignistypen findest du hier).
Gib die URL ein, an die der Webhook die Nachricht senden soll.
Klicke auf bestätigen.
Du siehst jetzt deinen neuen Webhook 🎉.
(Optional) Mit "Test" kannst du ein Ereignis simulieren und prüfen, ob dein Webhook funktioniert.
Ereignistypen
Du kannst verschiedene Ereignisse im Lebenszyklus einer Rechnung abonnieren:
invoice-finalize– Wird ausgelöst, wenn eine Rechnung erstellt und geöffnet wird.invoice-revert– Wird ausgelöst, wenn eine Rechnung rückgängig gemacht wird.invoice-pay– Wird ausgelöst, wenn eine Rechnung vollständig bezahlt wird.invoice-dispute– Wird ausgelöst, wenn eine Rechnung angefochten wird.
Die folgenden Ereignisse sind veraltet und sollten nicht mehr verwendet werden.
invoice-createinvoice-update
Event-Payload
Alle diese Ereignisse senden die gleiche Payload-Struktur wie unten beschrieben.
Hier findest du auch hier die JSON-Schema-Beschreibung der Payload.
Feldbeschreibung
Field | Type | Description | Example |
Beispiel
{...}