Webhooks und Ereignisse
Ein Webhook ist ein systemischer Benachrichtigungsdienst, der die asynchrone Integration zwischen Systemen ermöglicht — Unico IDCloud benachrichtigt Ihr Backend, sobald ein Prozess seinen Zustand ändert, sodass Sie nicht regelmäßig nach Updates abfragen müssen.
Dieser Abschnitt behandelt die vier Dinge, die Sie für die Webhook-Integration benötigen: die Einrichtung des Endpunkts und der Authentifizierung, die von Unico gesendeten Ereignisse, die Fallback-Strategie und die Sicherheits- und Zuverlässigkeitsmuster, die Ihr Endpunkt implementieren muss.
Wann Webhooks verwenden
Webhooks sind die empfohlene Methode, um über den Abschluss von Prozessen benachrichtigt zu werden. Sie sind besonders relevant für:
- Human Token Journey (
humantoken,humantoken+revalidation) — um benachrichtigt zu werden, wenn der Benutzer die Journey eines mit Prozess erstellen erstellten Prozesses abschließt. Webhooks werden nur im Terminalzustand (PROCESS_STATE_FINISHED) ausgelöst; es werden keine Zwischen-Fortschrittsereignisse zugestellt. - API Only-Flows (
api+humantoken,api+liveness+humantoken,api+liveness+humantoken+revalidation) — das Ergebnis kommt bereits in der Antwort von Prozess erstellen, daher hängen diese Flows nicht vom Webhook ab.
Webhooks ergänzen die GetProcess-Endpunkte, ersetzen sie aber nicht. Siehe Fallback.
In diesem Abschnitt
- Einrichtung — Endpunktregistrierung, Authentifizierungsmethoden (OAuth2, Basic, API-Schlüssel), Wiederholungseinstellungen.
- Ereignistypen — die von Unico gesendeten Ereignisse und die Payload-Struktur.
- Sicherheit — Idempotenz, Gleichzeitigkeitslimit und Fehlerrate.
- Fallback — wie das Prozessergebnis abgerufen wird, wenn der Webhook nicht verfügbar ist.