Webhook

Ein Webhook ist eine Nachricht, die das System des Anbieters an eine von dir angegebene Adresse sendet, sobald ein definiertes Ereignis eintritt. Ohne Webhook muss deine Software immer wieder bei der API des Anbieters nachfragen, ob sich etwas geändert hat – das kostet Anfragen und verursacht Verzögerungen für den Kunden. Aniva sendet bei jeder Statusänderung einer Probe einen signierten Webhook, sodass dein System nur einmal pro Änderung benachrichtigt wird.

Das Signieren ist wichtig, weil die von dir veröffentlichte Adresse von jedem erreicht werden kann, der sie findet. Eine Signatur ermöglicht es deinem Code zu überprüfen, ob eine Nachricht wirklich vom Anbieter stammt, bevor dein Produkt darauf reagiert. Wiederholungsversuche sind aus demselben Grund wichtig, denn dein Endpunkt wird irgendwann einmal nicht erreichbar sein und die Nachricht muss dann erneut gesendet werden.

• Frag nach, welche Ereignisse einen Webhook auslösen und was die einzelnen Nachrichten enthalten.
• Frag nach, wie Nachrichten signiert werden und wo die Überprüfungsschritte dokumentiert sind.
• Frag nach, was passiert, wenn dein Endpunkt ausgefallen ist, und wie viele Wiederholungsversuche es dann gibt.
• Frag nach, ob vergangene Ereignisse nach einem Ausfall auf deiner Seite erneut gesendet werden können.

Ein Webhook macht die API nicht überflüssig, denn dein System liest immer noch das vollständige Ergebnis aus, sobald die Nachricht ihm mitteilt, dass eines vorliegt. Teams, die auf Webhooks verzichten, fragen stattdessen meist nach einem festen Zeitplan die API ab, was für den Kunden, der auf einen Bericht wartet, langsamer ist.

In diesem Glossar bezieht sich „REST-API“ auf die Schnittstelle, die dein Code aufruft, während „Time-to-Result“ die Wartezeit bezeichnet, die dein Kunde wahrnimmt, und „Partner-Portal“ den Weg für ein Team ohne Entwickler beschreibt.