WebHooks anlegen

Mit WebHooks können Sie sich über eine Vielzahl möglicher Ereignisse in elektronischer Form informieren lassen. Ein klassischer Anwendungsfall ist Beispielsweise eine Information an Sie, wenn durch einen Ihrer Mitarbeiter eine Rechnung als vollständig bezahlt markiert wurde. Die Installation solcher elektronischen Benachrichtigungen erfolgt programmiertechnisch. Sie benötigen also zur Umsetzung einen Softwareentwickler/Programmierer.

Sobald ein durch Sie definiertes Ereignis eingetreten ist, sendet easybill einen sogenannten POST-Request an eine von Ihnen hinterlegte URL. Alle betroffenen Daten werden dabei mitgeliefert. Das heißt im Falle des oben genannten Beispiels nicht nur die Tatsache der vollständigen Bezahlung, sondern auch deren Höhe sowie die Daten des bezahlten Dokumentes. Die aufgerufene URL muss im Fall der erfolgreichen Datenübermittlung mit einem HTTP-Statuscode 200 antworten. Abweichende Status-Codes werden als Fehler interpretiert.

Ereignisse

In easybill kann unter Hilfe > WebHooks für diverse Ereignisse eine URL hinterlegt werden. Hier kann auch das Format (XML oder JSON) festgelegt werden und bei Bedarf ein Secret-Key Parameter angegeben werden, um die URL zu schützen.

WebHook-Aufruf

Tritt das Ereignis ein, sendet easybill einen POST-Request.

HTTP-Header

1) Reihenfolge

Werden durch ein Ereignis weitere Ereignisse ausgelöst (Beispiel: Das Verbuchen einer Zahlung sorgt dafür, dass die Rechnung als bezahlt markiert wird), ist die Reihenfolge der WebHook-Requests unbestimmt. Jeder Request besitzt aber das Header-Feld X-easybill-Webhook-Delivery. Hiermit können die Requests chronologisch sortiert werden.

2) Ereignis

Mit dem Header X-easybill-Event wird das Event angegeben, das den WebHook-Request ausgelöst hat.

Nähere Erläuterungen zu den einzelnen WebHooks finden Sie unter dem folgenden Link: WebHooks - Beispiele

Derzeit mögliche Ereignisse in easybill: