Webhooks einrichten

Mit Webhooks verbindest du weboffice mit anderen Systemen. Sobald in weboffice etwas Wichtiges passiert – etwa eine neue Rechnung oder eine Kundenänderung – sendet weboffice automatisch eine Nachricht an eine Adresse deiner Wahl. Das andere System kann darauf reagieren, ohne dass jemand eingreifen muss.

So kommst du hierher

1. Öffne die Seitenleiste und wähle Web.Office.Administration → Webhooks.
2. Du siehst eine Liste aller bisherigen Webhooks.

Voraussetzungen

Du benötigst das Recht Einstellungen verwalten, um Webhooks einzurichten.

So gehst du vor

Einen neuen Webhook hinzufügen

1. Klicke auf Hinzufügen oben in der Liste.

2. Ein Eingabefenster öffnet sich. Trage ein:

   • Bezeichnung: Ein Name, unter dem du diesen Webhook später erkennst.
   • URL: Die vollständige Internetadresse, an die weboffice die Daten senden soll (zum Beispiel https://example.com/webhook). Diese Adresse muss von weboffice aus erreichbar sein.
   • Secret (HMAC-SHA256): Ein Sicherheitsschlüssel, mit dem du die Nachrichten von weboffice überprüfen kannst. weboffice berechnet aus diesem Secret einen Code mit, den das empfangende System nutzen kann, um sicherzustellen, dass die Nachricht wirklich von weboffice kommt. Du kannst hier einen beliebigen Text eintragen; das empfangende System muss denselben Secret kennen.
   • Standort: Wähle aus, für welchen Standort dieser Webhook aktiv sein soll.

3. Wähle unter Events aus, welche Ereignisse weboffice an diese Adresse melden soll. Das Fenster zeigt alle verfügbaren Ereignisse – zum Beispiel "Kunde erstellt", "Rechnung aktualisiert" oder "Zahlung eingegangen". Alle Ereignisse sind anfangs ausgewählt; deselektiere die, die du nicht brauchst.

4. Klicke auf Speichern. Der Webhook ist nun aktiv.

Einen existierenden Webhook bearbeiten

1. Doppelklicke auf den Webhook in der Liste, oder klicke auf die Schaltfläche Bearbeiten (Stift-Symbol) in der Zeile.
2. Das Eingabefenster öffnet sich. Änder die Felder wie oben beschrieben.
3. Klicke auf Speichern.

Einen Webhook testen

Bevor du einen Webhook produktiv einsetzt, solltest du prüfen, ob die Verbindung funktioniert.

1. Wähle den Webhook aus der Liste.
2. Klicke auf Test senden (Papierflugzeug-Symbol) in der Zeile.
3. weboffice sendet eine Testnachricht an die hinterlegte URL. Du siehst eine Bestätigung, dass das Testen gestartet wurde.

Einen Webhook archivieren oder wiederherstellen

Webhooks, die du nicht mehr brauchst, kannst du archivieren, ohne sie zu löschen. Du kannst sie später jederzeit wieder aktivieren.

1. Klicke auf Archivieren (Kasten-Symbol) neben dem Webhook.
2. Ein Bestätigungsfenster fragt, ob du den Webhook wirklich archivieren möchtest. Bestätige mit Klick.
3. Der Webhook ist nun archiviert und sendet keine Nachrichten mehr.

Um einen archivierten Webhook wiederherzustellen:

1. Schalte oben rechts Zeige archivierte Einträge ein.
2. Archivierte Webhooks erscheinen jetzt in der Liste.
3. Klicke auf Wiederherstellen (Pfeil-zurück-Symbol) neben dem Webhook.
4. Bestätige die Aktion. Der Webhook ist wieder aktiv.

Aufbau der Webhookliste

Die Liste zeigt alle Webhooks (bzw. die archivierten, wenn du den Schalter oben aktiviert hast):

• Bezeichnung: Der Name, unter dem du den Webhook anlegst.
• URL: Die Adresse, an die weboffice sendet.
• Events: Die Anzahl der Ereignisse, auf die dieser Webhook reagiert.
• Status: Zeigt, ob der Webhook läuft, Fehler hat oder pausiert ist.
  • Läuft (grünes Häkchen): Der Webhook funktioniert.
  • Nicht erreichbar (Ausrufezeichen, orange): weboffice konnte die URL mehrfach nicht erreichen. Prüfe die URL und das Netzwerk. Der Webhook versucht weiter, die Nachricht zu senden.
  • Pausiert seit (Pause-Symbol, rot): Das empfangende System antwortet lange nicht oder meldet Fehler. weboffice pausiert diesen Webhook automatisch, um die Last zu reduzieren. Speichere den Webhook erneut ab oder führe einen Test durch, um ihn wieder einzuschalten.

Was danach passiert

Sobald du einen Webhook speicherst, ist er aktiv. weboffice sendet ab sofort Nachrichten für die gewählten Ereignisse an die URL. Das empfangende System sollte jede Nachricht mit dem HTTP-Code 200 bestätigen – sonst versucht weboffice die Nachricht später erneut zu senden.

Du kannst jederzeit in die Liste zurückkehren und einen Webhook anpassen oder testen.

Tipps und Hinweise

• URL muss erreichbar sein: weboffice sendet von deinem Server aus. Die URL muss also vom Server aus im Internet erreichbar sein.
• Secret teilen: Gib den Secret nur an die Person oder das System weiter, das die Webhooknachrichten empfangen soll. Mit dem Secret kann das empfangende System überprüfen, dass die Nachricht wirklich von dir kommt.
• Zu viele oder zu wenig Events?: Du kannst jederzeit zurück in den Webhook und die Events anpassen. weboffice merkt sofort die Änderung.
• Pausing-Logik: Wenn weboffice feststellt, dass die URL lange nicht erreichbar ist, pausiert es den Webhook automatisch. Das ist normal und schützt deinen Server. Behebe das Problem (prüfe die URL, die Firewall, das empfangende System), und speichere oder teste den Webhook erneut.
• API-Dokumentation: Klicke auf API-Dokumentation, um eine vollständige Beschreibung aller Ereignistypen und Datenformate zu sehen.