Ereignistypen
Webhook-Payloads beschreiben einen Zustandsübergang eines Prozesses. Diese Seite dokumentiert das Payload-Schema und die vollständige Aufzählung der lastEvent-Werte.
Payload-Schema
| Feld | Typ | Beschreibung |
|---|---|---|
processId | string (UUID) | ID der Transaktion. |
state | string | Aktueller Zustand der Transaktion. Derzeit: PROCESS_STATE_FINISHED. |
flow | string | Flow, der für diese Transaktion ausgeführt wurde (z. B. api+humantoken, api+liveness+humantoken, humantoken, humantoken+revalidation, api+liveness+humantoken+revalidation). |
lastEvent | string | Letztes Ereignis der Transaktion. Wird nur zurückgegeben, wenn der Prozess abgelaufen ist, bevor der Benutzer den Flow abgeschlossen hat. |
lastEventDescription | string | Menschenlesbare Beschreibung von lastEvent. Wird nur zurückgegeben, wenn der Prozess abgelaufen ist, bevor der Benutzer den Flow abgeschlossen hat. |
Das Feld state in Webhook-Payloads verwendet das Präfix PROCESS_STATE_*. Dies ist ein eigenständiges Vokabular, das sich von den Feldern result und status unterscheidet, die vom GetProcess-Endpunkt zurückgegeben werden und PROCESS_RESULT_* verwenden. Behandeln Sie diese nicht als austauschbar.
Beispiel-Payload
Abgeschlossen — erfolgreich
{
"processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
"state": "PROCESS_STATE_FINISHED",
"flow": "humantoken"
}
Abgeschlossen — abgelaufen
{
"processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
"state": "PROCESS_STATE_FINISHED",
"flow": "humantoken",
"lastEvent": "EVENT_TYPE_SESSION_ENDED",
"lastEventDescription": "Session ended by timeout or by new session created"
}
Aufzählung von lastEvent
Die vollständige Liste der Werte, die in lastEvent erscheinen können:
| Ereignis | Beschreibung |
|---|---|
EVENT_TYPE_PROCESS_CREATED | Prozess erstellt |
EVENT_TYPE_PROCESS_STARTED_BY_USER | Prozess vom Benutzer gestartet |
EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED | Schritt zur Identitätsvalidierung abgeschlossen |
EVENT_TYPE_SESSION_ENDED | Sitzung durch Timeout oder durch eine neue Sitzung beendet |
Die Menge der Ereignisse kann sich weiterentwickeln. Behandeln Sie die Ereignisse, auf die Ihr Endpunkt reagiert, als Konfiguration und nicht als hartcodierte Konstanten — so können neue Ereignisse ohne ein Deployment aktiviert werden.
Vollständiges Prozessergebnis abrufen
Der Webhook-Payload signalisiert, dass ein Prozess abgeschlossen wurde, enthält jedoch nicht das Ergebnis selbst. Um das Ergebnis abzurufen — zusammen mit Erfassungsdaten, biometrischen Werten, Dokumentenfeldern usw. — rufen Sie den entsprechenden GetProcess-Endpunkt auf, siehe Prozess abrufen.