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

Webhook-Verwaltung

Webhook-Verwaltung

Webhooks ermöglichen es dir, externe Systeme automatisch über Ereignisse in weboffice zu informieren. Wenn beispielsweise eine neue Rechnung erstellt wird, kann dein System automatisch benachrichtigt werden. Hier verwaltest du alle deine Webhook-Verbindungen.

Voraussetzungen

  • Grundkenntnisse über Webhooks und APIs
  • Eine externe Anwendung oder ein System, das Webhook-Nachrichten empfangen kann
  • Die URL des Zielsystems muss erreichbar sein

Aufbau der Seite

Die Seite bietet folgende Bereiche:

Werkzeugleiste (oben)

  • Hinzufügen-Schaltfläche: Erstellt einen neuen Webhook (nur bei aktiven Webhooks)
  • API-Dokumentation-Schaltfläche: Öffnet die technische Dokumentation
  • Schalter "Zeige archivierte Einträge": Wechselt zwischen aktiven und archivierten Webhooks

Webhook-Tabelle

  • Bezeichnung: Dein Name für den Webhook
  • URL: Ziel-Adresse, an die Nachrichten gesendet werden
  • Events: Anzahl der überwachten Ereignistypen
  • Aktionsschaltflächen: Test, Bearbeiten, Archivieren/Wiederherstellen

So arbeitest du mit dieser Seite

Neuen Webhook erstellen

  1. Klicke auf die grüne "Hinzufügen"-Schaltfläche
  2. Gib eine aussagekräftige Bezeichnung ein (z.B. "Buchhaltungssystem")
  3. Trage die URL deines Zielsystems ein
  4. Wähle die Ereignisse aus, die überwacht werden sollen
  5. Speichere den Webhook

Webhook bearbeiten

  1. Doppelklicke auf einen Webhook in der Tabelle ODER
  2. Klicke auf die blaue Bearbeiten-Schaltfläche
  3. Ändere die Einstellungen nach deinen Wünschen
  4. Speichere die Änderungen

Webhook testen

  1. Klicke auf die grüne Test-Schaltfläche bei dem gewünschten Webhook
  2. Eine Test-Nachricht wird an die konfigurierte URL gesendet
  3. Du erhältst eine Bestätigung über den Versand
  4. Prüfe in deinem Zielsystem, ob die Nachricht angekommen ist

Webhook archivieren

  1. Klicke auf die rote Archivieren-Schaltfläche
  2. Bestätige die Archivierung
  3. Der Webhook wird deaktiviert und in das Archiv verschoben

Archivierte Webhooks anzeigen

  1. Aktiviere den Schalter "Zeige archivierte Einträge"
  2. Die Tabelle zeigt nun archivierte Webhooks
  3. Klicke auf "Wiederherstellen" um einen Webhook zu reaktivieren

Tipps und Hinweise

  • API-Dokumentation: Nutze die API-Dokumentation für technische Details
  • Test-Funktion: Teste jeden neuen Webhook vor dem produktiven Einsatz
  • Eindeutige Namen: Verwende aussagekräftige Bezeichnungen wie "ERP-System" oder "Warenwirtschaft"
  • URL-Format: Achte auf das korrekte Format der Ziel-URL (https://...)
  • Ereignisauswahl: Wähle nur die Ereignisse aus, die du wirklich benötigst
  • Sicherheit: Verwende HTTPS-URLs für sichere Übertragung
  • Monitoring: Überprüfe regelmäßig das Webhook-Protokoll

Häufige Ereignistypen

  • Rechnung erstellt: Neue Rechnung wurde angelegt
  • Zahlung eingegangen: Rechnung wurde bezahlt
  • Kunde angelegt: Neuer Kunde wurde registriert
  • Termin gebucht: Neuer Termin wurde vereinbart
  • Artikel geändert: Artikeldaten wurden aktualisiert
  • Bestellung eingegangen: Neue Shop-Bestellung

Verwandte Seiten