weboffice.digital - Dokumentation
Branche Beauty Branche Gastro Branche Handel
PDF

Webhook einrichten

Webhook einrichten

Ansicht dieser Seite

Mit Webhooks benachrichtigst du externe Systeme automatisch, wenn sich Daten in weboffice ändern – etwa wenn ein Kunde angelegt, eine Rechnung erstellt oder ein Termin aktualisiert wird. Das externe System erhält sofort eine Nachricht und kann entsprechend reagieren.

So kommst du hierher

Öffne das Menü und wähle System > Webhooks.

Voraussetzungen

Du brauchst das Recht, Einstellungen zu verwalten. Außerdem musst du die URL des Systems kennen, das die Benachrichtigungen empfangen soll.

Aufbau der Übersicht

Die Webhooks-Liste zeigt alle eingerichteten Webhooks in einer Tabelle mit drei Spalten:

  • Bezeichnung: Der Name, unter dem du den Webhook erkennst
  • URL: Die Adresse des externen Systems, das die Benachrichtigungen erhält
  • Events: Wie viele verschiedene Ereignistypen dieser Webhook überwacht

Oben rechts kannst du mit dem Schalter Zeige archivierte Einträge auch alte, deaktivierte Webhooks sehen.

So gehst du vor

Neuen Webhook anlegen

  1. Klicke auf Hinzufügen.

    Ein Eingabefenster öffnet sich.

  2. Gib unter Bezeichnung einen Namen ein, unter dem du diesen Webhook später wiederfindest.

  3. Trage die URL des externen Systems ein – das ist die Adresse, an die weboffice die Benachrichtigungen sendet.

  4. Fülle das Feld Secret (HMAC-SHA256) aus. Das ist ein Geheimnis, das weboffice beim Versand an die URL anhängt. Das externe System kann so prüfen, dass die Nachricht wirklich von dir kommt. Du kannst eine beliebige Zeichenfolge eintragen oder ein bestehendes Secret kopieren.

  5. Wähle einen Standort – nur Ereignisse dieses Standorts werden überwacht.

  6. Unter Events siehst du alle möglichen Ereignistypen, die der Webhook überwachen kann (z. B. „Kunde erstellt", „Rechnung bezahlt", „Artikel aktualisiert"). Alle sind am Anfang aktiviert. Falls du nur bestimmte Ereignisse brauchst, deaktiviere die anderen.

  7. Klicke auf Speichern.

    Der Webhook wird angelegt. weboffice merkt sich Bezeichnung, URL, Secret und die ausgewählten Events und sendet künftig Benachrichtigungen an diese Adresse.

Webhook bearbeiten

  1. Doppelklick auf einen Webhook in der Liste – oder klick auf das Stift-Symbol in seiner Zeile.

  2. Ändere Bezeichnung, URL, Secret oder die Events wie oben beschrieben.

  3. Klicke auf Speichern.

Webhook testen

Bevor du einen Webhook live nutzt, kannst du ihn prüfen:

  1. Klick auf das Papierflugzeug-Symbol in der Zeile des Webhooks.

    weboffice sendet sofort eine Test-Nachricht an die URL. Du siehst eine Bestätigung, dass die Test-Nachricht versendet wurde. Ob das externe System die Nachricht tatsächlich empfangen hat, musst du dort prüfen.

Webhook deaktivieren oder wiederherstellen

  1. Klick auf das Archiv-Symbol in der Zeile des Webhooks.

  2. Bestätige die Sicherheitsabfrage.

    Der Webhook wird archiviert (deaktiviert). weboffice sendet ihm künftig keine Benachrichtigungen mehr.

    Um einen archivierten Webhook später zu reaktivieren, aktiviere den Schalter Zeige archivierte Einträge, klick auf das Uhren-Symbol und bestätige.

Was danach passiert

Der Webhook ist jetzt eingerichtet. Sobald eines der überwachten Ereignisse eintritt – etwa wenn ein Kunde angelegt wird oder eine Rechnung bezahlt wird – sendet weboffice eine Nachricht an die hinterlegte URL. Das externe System kann darauf reagieren.

Der Webhook bleibt bestehen, bis du ihn archivierst. Du kannst ihn jederzeit bearbeiten, um andere Ereignisse zu überwachen oder die URL zu ändern.

Tipps und Hinweise

  • Test vor dem Produktivbetrieb: Nutze die Test-Funktion (Papierflugzeug-Symbol), um zu prüfen, ob das externe System die Nachricht empfängt und verarbeitet.
  • Secret absichern: Das Secret sollte du genauso behandeln wie ein Passwort. Teile es nur mit dem externen System und ändere es regelmäßig.
  • Nur nötige Events: Wenn du nur wenige Ereignistypen brauchst, deaktiviere die anderen. Das spart Bandbreite und Verarbeitungszeit beim externen System.
  • Standort beachten: Ein Webhook überwacht nur den Standort, den du beim Anlegen ausgewähst hast. Wenn mehrere Standorte Benachrichtigungen senden sollen, brauchst du mehrere Webhooks.
  • API-Dokumentation: Klick auf API-Dokumentation, um die genaue Struktur der Nachrichten zu sehen, die weboffice versendet. Das brauchst du, um das externe System richtig einzurichten.

Suche