Nutzen Sie unsere neue Online-Hilfe unter https://help.scopevisio.com/new
Schnittstelle Webhooks
- Silvan Arz
Webhook in Scopevisio einrichten
Webhooks senden Daten in Echtzeit, sobald ein bestimmtes Ereignis eintritt. Dadurch kann eine Anwendung automatisch Informationen an eine andere Anwendung weitergeben.
Voraussetzungen
Um einen Webhook in Scopevisio einzurichten, benötigen Sie Administratorrechte in Ihrer Scopevisio-Organisation. Weitere Informationen dazu finden Sie in der Online-Hilfe unter Benutzer verwalten.
Externe Verarbeitung für den Webhook einrichten
Damit Webhooks genutzt werden können, muss eine Externe Verarbeitung konfiguriert werden. Navigieren Sie dazu in der Systemadministration zur Funktionsanbindung und öffnen Sie die Externe Verarbeitung. In dem sich öffnenden Fenster klicken Sie unten rechts auf "Hinzufügen" und wählen im erscheinenden Formular als Typ "Webhook" aus. Anschließend vergeben Sie eine passende Bezeichnung, beispielsweise "TestWebhookURL". Der Status sollte auf "Aktiviert" gesetzt werden. Nun tragen Sie die URL des Webhooks ein.
Zusätzlich können Sie bei Bedarf die Timeout-Werte anpassen, wobei die Standardwerte in den meisten Fällen ausreichend sind. Falls der Webhook asynchron laufen oder spezielle Header-Daten enthalten soll, können diese Attribute ebenfalls hier festgelegt werden.
Aktivität für den Webhook definieren
Damit der Webhook ausgelöst wird, muss eine entsprechende Aktivität eingerichtet werden. Dazu navigieren Sie in der Organisation zu den Aktivitäten und öffnen das Aktivitätsjournal. Dort können neben E-Mail-Benachrichtigungen auch Webhooks konfiguriert werden.
Im Aktivitätsjournal wählen Sie unter dem Punkt Benachrichtigungen bei den Nachrichtenarten "Webhook" aus.
Anschließend klicken Sie auf das Plus-Symbol neben dem Eintrag "Nachrichtenprofile", woraufhin sich ein Fenster öffnet. Dort tragen Sie den Namen des Webhooks ein.
Bei "Versenden am / um" können Sie nun definieren, wann der Webhook ausgelöst werden soll, beispielsweise sofort oder täglich.
Danach wählen Sie im Aktivitätsjournal die zuvor eingerichtete Externe Verarbeitung aus.
Zum Abschluss ist es wichtig, die relevanten Ereignisse festzulegen, die den Webhook auslösen sollen, wie zum Beispiel "Wiederkehrende Rechnung erstellt". Um die Konfiguration zu speichern, klicken Sie erneut auf das Plus-Symbol neben "Nachrichtenprofile".
Der erstellte Webhook erscheint dann unter den Benachrichtigungen und kann dort bei Bedarf aktiviert oder deaktiviert werden.
Beispiel des Inhalts Webhook Wiederkehrende Rechnung ändern: