Webhooks einrichten und verwalten

Mit Webhooks versendest du automatisch Benachrichtigungen an externe Systeme, wenn sich wichtige Daten in weboffice ändern – etwa wenn ein Kunde angelegt wird, eine Rechnung bezahlt ist oder ein Auftrag erstellt wurde. So können andere Programme in Echtzeit reagieren, ohne weboffice ständig abzufragen.

So kommst du hierher

Klick in der Seitenleiste auf Web.Office.Administration und dann auf Webhooks.

Voraussetzungen

Du benötigst das Recht Einstellungen verwalten. Für jeden Webhook legst du einen Standort fest – stelle sicher, dass du Zugriff auf den Standort hast, den du verwenden möchtest.

So gehst du vor

Neuen Webhook erstellen

1. Klick auf Hinzufügen.

2. Im Eingabefenster gibst du ein:

   • Bezeichnung: Ein Name, unter dem du den Webhook erkennst (z. B. "CRM-Kundensync").
   • URL: Die Adresse, unter der das externe System auf deine Benachrichtigungen wartet. Die URL muss mit https:// beginnen.
   • Secret (HMAC-SHA256): Ein Kennwort, das weboffice zum Signieren der Nachrichten nutzt. Das externe System prüft damit, dass die Nachricht wirklich von weboffice stammt. Du kannst diesen Wert selbst eingeben oder leer lassen.
   • Standort: Wähle den Standort aus, für den dieser Webhook gelten soll.

3. Unter Events wählst du aus, welche Vorgänge weboffice melden soll:

   • Ereignisse aus dem Kundenmanagement: Kunde erstellt, aktualisiert, gelöscht
   • Ereignisse aus der Abrechnung: Rechnung erstellt, aktualisiert, bezahlt, storniert, Zahlung eingegangen
   • Ereignisse aus Terminen: Termin erstellt, aktualisiert, storniert
   • Ereignisse aus Artikeln und Aufträgen: Artikel erstellt, aktualisiert, Auftrag erstellt, aktualisiert
   • Ereignisse aus Belegen und Mitarbeitern: Beleg erstellt, Mitarbeiter erstellt, aktualisiert

   Standardmäßig sind alle verfügbaren Events angehakt. Du kannst einzelne abwählen, wenn du nur bestimmte Ereignisse melden möchtest.

4. Klick auf Speichern.

Bestehenden Webhook bearbeiten

1. Suche den Webhook in der Liste und doppelklick auf seinen Namen, oder klick auf das Stift-Symbol in der Zeile.
2. Ändere die Daten wie gewünscht.
3. Klick auf Speichern.

Webhook testen

Bevor du einen Webhook produktiv einsetzt, kannst du prüfen, ob die Verbindung funktioniert:

1. Suche den Webhook in der Liste.
2. Klick auf das Flugzeug-Symbol in der Zeile – weboffice sendet jetzt eine Test-Nachricht an die URL.
3. Du siehst eine Bestätigung, dass die Test-Nachricht versendet wurde.

Webhook archivieren oder wiederherstellen

Webhooks, die du nicht mehr brauchst, archivierst du, statt sie zu löschen – so kannst du sie später jederzeit wieder aktivieren:

1. Suche den Webhook in der Liste.
2. Klick auf das Archiv-Symbol in der Zeile.
3. Bestätige die Nachfrage.

Der Webhook ist jetzt archiviert und wird nicht mehr versendet. Um archivierte Webhooks zu sehen und ggf. wiederherzustellen:

1. Klick oben rechts auf Zeige archivierte Einträge.
2. In der Liste erscheinen jetzt auch die archivierten Webhooks.
3. Klick auf das Uhr-Symbol, um einen Webhook wiederherzustellen.
4. Bestätige die Nachfrage.

Aufbau der Webhook-Liste

Die Tabelle zeigt für jeden Webhook:

• Bezeichnung: Der Name, unter dem du den Webhook erkennst.
• URL: Die Zieladresse der Benachrichtigungen.
• Events: Die Anzahl der Events, die dieser Webhook überwacht.
• Aktionen: Schaltflächen zum Testen, Bearbeiten, Archivieren oder Wiederherstellen.

Oben in der Werkzeugleiste findest du außerdem einen Link zur API-Dokumentation – dort beschreibt weboffice genau, welche Daten in jeder Nachricht stehen und wie du sie verarbeitest.

Was danach passiert

Der Webhook ist jetzt aktiv. Immer wenn einer der ausgewählten Vorgänge eintritt, sendet weboffice eine verschlüsselte Nachricht an die URL. Das externe System kann dann automatisch reagieren – etwa einen neuen Kundensatz anlegen, wenn du in weboffice einen Kunden hinzufügst.

Tipps und Hinweise

• Nur HTTPS-Adressen: weboffice akzeptiert nur URLs mit https://. Das schützt deine Daten auf dem Weg zum externen System.
• Secret nicht vergessen: Wenn du ein Secret eingibst, muss das externe System es kennen, um die Signatur zu prüfen. Notier dir das Secret oder schreib es auf – weboffice zeigt es nicht nochmal an.
• Test vor dem Betrieb: Nutze die Test-Funktion, um sicherzustellen, dass das externe System die Nachrichten auch wirklich empfängt.
• Pro Standort einen Webhook: Jeder Webhook ist an einen Standort gebunden. Wenn mehrere Standorte die gleichen Events brauchen, erstelle mehrere Webhooks.
• Fehlerhafte URLs: Wenn weboffice eine Nachricht nicht versendet, versucht es mehrmals. Prüfe die URL auf Tippfehler, wenn lange Zeit keine Daten ankommen.