Mit Webhooks teilst du weboffice der Außenwelt mit, wenn sich wichtige Daten ändern. Sobald ein Kunde erstellt wird, eine Rechnung bezahlt wird oder ein Termin ausfällt, schickt weboffice eine automatische Nachricht an eine Adresse deiner Wahl. So können andere Programme reagieren, ohne dass du selbst etwas tun musst.
So kommst du hierher
Öffne oben links im Seitennamen Web.Office.Administration und gehe zu System > Webhooks.
Voraussetzungen
Du benötigst das Recht zur Verwaltung von Systemeinstellungen. Technische Kenntnisse sind nicht erforderlich – die anderen Programme, an die du Benachrichtigungen sendest, müssen nur eine Webadresse haben.
So gehst du vor
Neuen Webhook anlegen
- Klicke auf Hinzufügen.
- Trage eine Bezeichnung ein, unter der du den Webhook wiederfindest.
- Gib die URL an – das ist die Adresse, an die weboffice die Benachrichtigungen schicken soll. Das muss eine vollständige Webadresse sein, z. B.
https://…. - Gib ein Secret (HMAC-SHA256) ein – ein geheimer Schlüssel, den der Empfänger braucht, um zu prüfen, dass die Nachricht wirklich von weboffice kommt. Du kannst hier eine lange, zufällige Zeichenkette eintragen oder das Feld leer lassen.
- Wähle einen Standort aus – weboffice sendet nur Änderungen von diesem Standort. Dieses Feld ist erforderlich.
- Wähle unter Events die Ereignisse aus, bei denen du benachrichtigt werden möchtest:
- Kunde erstellt, aktualisiert, gelöscht
- Rechnung erstellt, aktualisiert, bezahlt, storniert
- Termin erstellt, aktualisiert, storniert
- Zahlung eingegangen
- Artikel erstellt, aktualisiert
- Auftrag erstellt, aktualisiert
- Beleg erstellt
- Mitarbeiter erstellt, aktualisiert
- Klicke auf Speichern. Der Webhook wird gespeichert und ist sofort aktiv.
Webhook testen
Um zu prüfen, ob dein Webhook funktioniert, suche ihn in der Liste und klicke auf Test senden (Papierflugzeug-Symbol). weboffice versendet dann eine Testnachricht an die eingestellte URL.
Webhook bearbeiten
Doppelklick auf einen Webhook in der Liste oder klicke auf Bearbeiten (Stift-Symbol). Du kannst Bezeichnung, URL, Secret und die gewählten Events ändern. Klicke auf Speichern, um die Änderungen zu übernehmen.
Webhook archivieren
Wenn du einen Webhook nicht mehr brauchst, aber die Historie behalten möchtest, klicke auf Archivieren (Kasten-Symbol). Der Webhook wird deaktiviert und aus der Standardansicht ausgeblendet.
Um archivierte Webhooks zu sehen, schalte oben rechts Zeige archivierte Einträge ein. Klicke dann auf Wiederherstellen, um einen Webhook wieder zu aktivieren.
Aufbau der Webhooks-Liste
Die Liste zeigt alle aktiven Webhooks mit folgenden Spalten:
- Bezeichnung: Der Name, unter dem du den Webhook anlegtest.
- URL: Die Zieladresse.
- Events: Die Anzahl der ausgewählten Ereignistypen.
Rechts neben jedem Webhook stehen die Schaltflächen zum Testen, Bearbeiten und Archivieren. Über den Link API-Dokumentation findest du technische Details zum Aufbau der Webhook-Nachrichten und Codebeispiele.
Was danach passiert
Der Webhook ist aktiv und sendet ab sofort Benachrichtigungen, sobald eines der gewählten Ereignisse auftritt. Jede Nachricht enthält die Daten der Änderung und ist mit deinem Secret signiert, sodass der Empfänger ihre Echtheit prüfen kann. Du kannst einen Webhook jederzeit bearbeiten oder archivieren.
Tipps und Hinweise
- Zu viele Events gewählt: Je mehr Events du aktivierst, desto mehr Nachrichten versendet weboffice. Wähle nur die Ereignisse aus, die du wirklich brauchst.
- Secret ändern: Wenn du das Secret später änderst, muss auch der Empfänger seinen Schlüssel aktualisieren.
- URL nicht erreichbar: Wenn die URL beim Versand nicht antwortet, versucht weboffice die Nachricht später erneut zu senden.
- Test vor dem Produktiveinsatz: Starte immer einen Testlauf, bevor du den Webhook in deiner Live-Umgebung nutzt.