Einen Webhook einrichten

Mit Webhooks verbindest du weboffice mit externen Systemen: Immer wenn in weboffice etwas Bestimmtes passiert (z. B. ein Kunde wird angelegt oder eine Rechnung bezahlt), schickt weboffice automatisch eine Nachricht an eine von dir angegebene Webadresse. So können andere Programme in Echtzeit auf Änderungen in weboffice reagieren.

So kommst du hierher

Öffne das Menü System in der Seitenleiste und wähle Webhooks.

Voraussetzungen

Du brauchst das Recht Verwaltung > Einstellungen bearbeiten.

Aufbau der Übersicht

Die Webhooks-Übersicht zeigt eine Liste aller eingerichteten Webhooks mit ihrer Bezeichnung, ihrer Zieladresse (URL) und der Anzahl der Event-Typen, die sie auslösen. Du kannst hier neue Webhooks anlegen, vorhandene bearbeiten oder testen.

So gehst du vor

Klicke auf Hinzufügen, um einen neuen Webhook anzulegen. Ein Eingabefenster öffnet sich mit zwei Bereichen: Webhook und Events.
Trage im Bereich Webhook folgende Angaben ein:
- Bezeichnung: Ein Name, unter dem du diesen Webhook wiederfindest (z. B. "CRM-Kundensync" oder "Lagerverwaltung")
- URL: Die Webadresse, an die weboffice die Meldungen schicken soll. Dies ist meist eine Adresse des externen Systems, z. B. https://mein-system.de/api/webhook
- Secret (HMAC-SHA256): Ein Passwort zwischen dir und dem externen System (optional, aber empfohlen). Das externe System kann damit prüfen, dass die Meldung wirklich von weboffice kommt. Lass dieses Feld leer, wenn das externe System kein Secret braucht.
- Standort: Wähle den Standort aus, für den dieser Webhook gelten soll. Nur Änderungen an diesem Standort werden übermittelt.
Im Bereich Events siehst du eine Liste aller möglichen Ereignisse (z. B. "Kunde erstellt", "Rechnung bezahlt", "Artikel aktualisiert"). Setze ein Häkchen bei jedem Ereignis, das diesen Webhook auslösen soll. Beim Anlegen eines neuen Webhooks sind alle Events vorausgewählt. Entferne Häkchen bei Ereignissen, die du nicht benötigst.
Klicke auf Speichern. Der Webhook ist nun aktiv. weboffice schickt künftig bei jedem ausgewählten Ereignis eine Meldung an die angegebene URL.

Was danach passiert

Der neue Webhook erscheint in der Liste. Du kannst ihn jederzeit noch ändern, indem du ihn doppelklickst oder auf das Stift-Symbol klickst.

Um zu prüfen, ob der Webhook funktioniert, klicke auf das Flugzeug-Symbol neben dem Webhook. weboffice schickt dann eine Test-Meldung an die angegebene URL. Eine Bestätigung zeigt dir, dass die Nachricht abgesendet wurde.

Einen Webhook, den du nicht mehr brauchst, archivierst du mit dem Kisten-Symbol. Archivierte Webhooks sind nicht gelöscht, sondern nur deaktiviert. Du kannst sie später jederzeit wiederherstellen. Um archivierte Webhooks zu sehen, aktiviere den Schalter Zeige archivierte Einträge.

Die genaue Format der Webhook-Meldungen findest du unter API-Dokumentation (die Schaltfläche öffnet ein neues Fenster).

Tipps und Hinweise

Standort beim Webhook: Jeder Webhook ist an genau einen Standort gebunden. Wenn du Webhooks für mehrere Standorte brauchst, musst du mehrere Webhooks mit derselben URL anlegen und jedem einen anderen Standort zuweisen.
Events nachträglich ändern: Du kannst jederzeit wieder in einen bestehenden Webhook gehen und einzelne Events hinzufügen oder entfernen. Speichern nicht vergessen.
External System muss erreichbar sein: Die URL muss von weboffice aus über das Internet erreichbar sein. Wenn dein externes System lokal läuft (z. B. auf localhost), funktioniert der Webhook nicht.