© Kellie L. Folkerts/Shutterstock.com
WebHooks in SharePoint

Kolumne: SharePoint ganz praktisch


Neben den klassischen serverseitigen Ereignisempfängern und den entfernten Ereignisempfängern unterstützt SharePoint seit Kurzem WebHooks. Dieser Mechanismus unterstützt ebenfalls die Benachrichtigung über Änderungen an SharePoint-Inhalten.

In den vorangegangenen Ausgaben ging es um Ereignisempfänger. Erläutert und vorgestellt wurden die klassischen Ereignisempfänger sowie die auf SharePoint-Add-ins (vormals: Apps for SharePoint) basierten. Beide Varianten bieten Möglichkeiten, um sich über Änderungen an SharePoint-Inhalten per Push-Verfahren informieren zu lassen. Mit WebHooks steht nun ein weiterer Mechanismus bereit, der einen Push-basierten Benachrichtigungsmechanismus bereitstellt. Im Gegensatz zu den beiden existierenden Ereignisempfängern unterstützen WebHooks allerdings nur bereits abgeschlossene Ereignisse, wie dass ein Listeneintrag hinzugefügt oder gelöscht wurde beispielsweise. Es findet keine Benachrichtigung statt, bevor eine Aktion ausgeführt wurde. Somit können über WebHooks auch keine anstehenden Ereignisse verhindert werden. In SharePoint stehen WebHooks erst seit Kurzem zur Verfügung, OneDrive und Outlook unterstützen WebHooks schon seit Längerem.

WebHooks

Viele weitere Systeme, u. a. auch Facebook, Google und WordPress, unterstützen WebHooks. WebHooks stellen allerdings keinen allgemeinen Standard dar, sondern beschreiben lediglich ein nicht standardisiertes Verfahren für eine Serverbenachrichtigungskommunikation. Die Hauptaufgabe von WebHooks liegt darin, über Änderungen an Ressourcen zu informieren. Im Schwerpunkt verhindert dieser Mechanismus extensive und serverbelastende Poll-Abfragen, indem die veränderte Ressource proaktiv über eine Callback-Funktion interessierte Beobachter informiert. Dazu muss sich ein Beobachter zunächst an der entsprechenden Ressource anmelden. Die Ressource trägt daraufhin die notwendigen Informationen zum Beobachter ein, um ihn im Fall von Änderungen informieren zu können. Im Fall einer Änderung prüft die Ressource alle registrierten Beobachter und benachrichtigt sie mittels einer einfachen HTTP-POST-Nachricht.

WebHooks in SharePoint

Im oberen Abschnitt wurde die allgemeine Funktionsweise von WebHooks beschrieben. Im Kontext von SharePoint stellt z. B. eine Ressource eine SharePoint-Liste dar. Das heißt, ein interessierter Beobachter kann sich über einen (WebHook-)API-Endpoint an einer SharePoint-Liste anmelden. Hierbei muss zwingend ein URL angegeben werden, an den im Fall einer Änderung Daten per POST...

Exklusives Abo-Special

Angebote für Teams

Für Firmen haben wir individuelle Teamlizenzen. Wir erstellen Ihnen gerne ein passendes Angebot.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang