Mit Webhooks kann ein externer Dienst Echtzeit-Push-Benachrichtigungen erhalten, sobald sich Daten in Workpath ändern – so halten Sie ein Data Warehouse, ein BI-Tool oder ein eigenes Dashboard mit Ihren Zielen, Key Results und Initiativen synchron, ohne die Connect API abzufragen.
Sie registrieren einen HTTPS-Endpunkt und wählen aus, welche Ereignisse Sie abonnieren möchten. Sobald ein passendes Ereignis eintritt, sendet Workpath eine signierte JSON-Anfrage an Ihren Endpunkt.
Hinweis: Die Webhooks-API befindet sich derzeit in der Beta-Phase – bereits nutzbar, aber Endpunkt-URLs, Payload-Formate und Verhalten können sich noch ändern.
Bevor Sie beginnen
- Nur Nutzer mit der Admin-Rolle können Webhook-Abonnements erstellen und verwalten.
- Ihr Endpunkt muss über HTTPS bereitgestellt werden – einfache HTTP-URLs werden abgelehnt.
Ein Webhook-Abonnement erstellen
- Gehen Sie zu Einstellungen → Integrationen → Webhooks.
- Klicken Sie auf Webhook hinzufügen.
- Geben Sie einen Titel ein – eine Bezeichnung, die beschreibt, wofür der Webhook dient.
- Geben Sie die Endpunkt-URL ein – die HTTPS-Adresse, an die Workpath Ereignisse senden soll.
- Wählen Sie die Ereignisse aus, die Sie abonnieren möchten (siehe unten).
- Stellen Sie sicher, dass Aktiv eingeschaltet ist, und klicken Sie auf Speichern.
Sie können ein Abonnement jederzeit bearbeiten, Aktiv ausschalten, um die Zustellung zu pausieren, ohne es zu löschen, oder es ganz löschen.
Verfügbare Ereignisse
Sie können Created-, Updated- und Deleted-Ereignisse für Ziele, Key Results und Initiativen abonnieren:
-
Ziele —
goal.created,goal.updated,goal.deleted -
Key Results —
key_result.created,key_result.updated,key_result.deleted -
Initiativen —
initiative.created,initiative.updated,initiative.deleted
Updated-Ereignisse werden nur ausgelöst, wenn sich die eigenen Eigenschaften einer Entität ändern (z. B. Titel, Beschreibung, Daten, Fortschritt oder Confidence Level). Reine Beziehungsänderungen – etwa Eigentümerwechsel, Label-Aktualisierungen oder Alignment-Verknüpfungen – lösen keinen Webhook aus.
Ereignisse verifizieren und verarbeiten
Jede Anfrage, die Workpath sendet, ist signiert, sodass Ihr Endpunkt vor der Verarbeitung bestätigen kann, dass sie tatsächlich von Workpath stammt. Jede Zustellung enthält außerdem eine Event-ID, mit der Sie doppelte Zustellungen aus Wiederholungsversuchen sicher ignorieren können.
Die Payload eines Ereignisses enthält die Kernfelder der Entität. Um zugehörige Daten abzurufen, schlagen Sie die Entität über die Connect API nach.
Technische Dokumentation
Alle technischen Details – Payload-Format, Signaturprüfung, den Public-Key-Endpunkt, das Wiederholungsverhalten und ein sofort lauffähiges Beispiel-Listener-Skript – finden Sie in der Entwicklerdokumentation: