Ein Webhook meldet ein Ereignis sofort an eine Adresse Ihrer Wahl: Ist eine Rechnung bezahlt, ein Angebot angenommen oder ein Auftrag angelegt, ruft BetriebsOffice die Adresse auf und schickt die Daten mit. So bleibt etwa ein Auswertungssystem oder Ihr Zapier-Ablauf ohne Verzögerung aktuell. Webhooks anlegen dürfen Personen mit dem Recht „Webhooks verwalten“.
Schritt für Schritt
- Öffnen Sie Einstellungen › Entwickler und Webhooks.
- Klicken Sie im Abschnitt Webhooks auf Webhook anlegen.
- Tragen Sie unter Ziel die Ziel-URL ein. Erlaubt sind nur HTTPS-Adressen und keine internen Adressen.
- Geben Sie eine Beschreibung ein, etwa „Buchhaltung“ oder „Zapier“.
- Wählen Sie unter Ereignisse aus, bei welchen Ereignissen die Adresse aufgerufen wird. Mindestens ein Ereignis ist nötig.
- Klicken Sie im Dialog auf Webhook anlegen.
- Kopieren Sie im Fenster Geheimnis für die Signatur das Geheimnis und hinterlegen Sie es im empfangenden System. Es wird nur jetzt angezeigt.
- Klicken Sie in der Zeile des Webhooks auf Testen. BetriebsOffice sendet ein Beispielereignis an die Adresse.
Welche Ereignisse es gibt
Zur Wahl stehen die Geschäftsereignisse der gebuchten Bereiche, zum Beispiel:
- Kunde angelegt
- Angebot versendet, Angebot angenommen, Angebot abgelehnt
- Auftrag angelegt, Auftrag abgeschlossen, Auftrag storniert
- Einsatz geplant, Einsatz verschoben, Einsatz abgesagt, Arbeitsschein abgeschlossen
- Rechnung festgeschrieben, Rechnung versendet, Rechnung bezahlt, Rechnung storniert, Zahlung eingegangen
- Eingangsrechnung erfasst, Prüfung abgeschlossen, Wartungsvertrag gekündigt
- Aufgabe angelegt, Aufgabe erledigt, Ablauf gestartet, Freigabe angefragt, Freigabe erteilt, Freigabe abgelehnt
Signatur prüfen
Jeder Aufruf trägt eine Signatur (HMAC-SHA256) in einer Kopfzeile, gebildet aus Zeitstempel und Inhalt mit Ihrem Geheimnis. Das empfangende System sollte sie prüfen und nur Aufrufe annehmen, deren Zeitstempel höchstens wenige Minuten alt ist. Die genauen Angaben stehen auf der Seite unter Signatur der Webhooks. Unter Beispiele finden Entwicklerinnen und Entwickler fertigen Code: Signatur prüfen (Node.js) und Signatur prüfen (PHP).
Vermuten Sie, dass das Geheimnis bekannt geworden ist, klicken Sie auf Geheimnis erneuern. Das alte Geheimnis gilt dann nicht mehr, und Sie hinterlegen das neue im empfangenden System.
Zustellungen kontrollieren
Die Liste zeigt je Webhook die Ziel-URL, die Ereignisse, die Letzte Zustellung und den Stand Aktiv oder Pausiert. Über Zustellungen sehen Sie jeden Aufruf mit Zeitpunkt, Ereignis, Stand (Ausstehend, Zugestellt, Fehlgeschlagen, Aufgegeben) und der Zahl der Versuche. Einen einzelnen Aufruf senden Sie mit Erneut zustellen noch einmal.
Schlägt eine Zustellung fehl, wiederholt BetriebsOffice sie mit wachsendem Abstand. Nach vielen Fehlschlägen wird der Webhook pausiert, ebenso wenn das Ziel den Status 410 meldet. Beheben Sie dann den Fehler beim Empfänger und schalten Sie den Webhook über Bearbeiten wieder auf Aktiv.
Tipps
- Webhooks liefern Ereignisse, Daten ändern Sie über die API. Zapier und Make nutzen beides zusammen und legen ihre Webhooks beim Einschalten eines Ablaufs selbst an.
- Soll ein Fremdsystem nur in bestimmten Fällen etwas erfahren, etwa nur bei Rechnungen über einem Betrag, verwenden Sie in einer Automatisierung die Aktion Webhook aufrufen.
- Webhooks senden Daten zu Kunden, Rechnungen und Zahlungen an fremde Adressen. Vergeben Sie das Recht dazu deshalb nur an wenige Personen.
Weiterlesen
-
REST-API und API-Zugänge
Wie Sie in BetriebsOffice einen API-Zugang mit passenden Berechtigungen anlegen, den Schlüssel sicher verwahren und Zugänge wieder widerrufen.
-
Automatisierungen: Wenn-Dann-Regeln ohne Programmierung
Wie Sie in BetriebsOffice Regeln anlegen, die bei Ereignissen Aufgaben erstellen, das Team informieren, Kunden erinnern oder Webhooks aufrufen.
-
Integrationen verwalten: Dokumentenablage, Telematik, Zapier und Make
Wie Sie in BetriebsOffice Nextcloud oder SharePoint als Dokumentenablage, Webfleet für das Fahrtenbuch sowie Zapier und Make anbinden und überwachen.