Webhooks

Webhooks#

sysman sysadmin

Allegra kann aufgrund einer Vorgangsänderung die URL eines anderen Systems aufrufen und damit dort Reaktionen auslösen. Sie können die URL und einen Header-Parameter angeben, um z.B. einen Authentifizierungstoken zu transportieren.

Webhooks anbinden

Webhooks anbinden#

Konfiguration#

Gehen Sie zu Verwaltung > Integrationen > Webhooks.

  • URL: Der Endpunkt des Webhooks, z.B. https://allegrademo.org/rest/theHook.

  • Webhook-Token: Ein String, der im Header eines jeden Aufrufs mitgegeben wird. Der Name des Parameters wird im folgenden Konfigurationsfeld festgelegt. Dieser Token wird in der Regel für die Authentifzierung beim aufgerufenen Server genutzt.

  • Name des Webhook-Token Header-Parameters: Sie können jedem Request einen Token in einem Header-Parameter mitgeben. Das wird meistens für die Authentifzierung durch einen Token genutzt. Der Standardname des Parameters ist „Authorization“.

  • HTTP-Aufrufmethode: GET oder POST. Im Falle von GET werden in der URL die Vorgangsnummer des betroffenen Vorgangs im Abfrageparameter „itemID“ sowie die Bereichs-Id über den Abfrageparameter „workspaceID“ mitgeteilt. Im Falle eine POST-Requests sind die Parameter im JSON-Body untergebracht.

Testen#

Klicken Sie auf Prüfung, um die Funktion des Webhooks zu verifizieren.

Speichern Sie den Webhook, wenn er zu Ihrer Zufriedenheit funktioniert.

Inhalt