Типы событий
Полезные данные webhook описывают переход состояния процесса. На этой странице описана схема полезных данных и полный перечень значений lastEvent.
Схема полезных данных
| Поле | Тип | Описание |
|---|---|---|
processId | string (UUID) | Идентификатор транзакции. |
state | string | Текущее состояние транзакции. В настоящее время: PROCESS_STATE_FINISHED. |
flow | string | Поток, выполненный для данной транзакции (например, api+humantoken, api+liveness+humantoken, humantoken, humantoken+revalidation, api+liveness+humantoken+revalidation). |
lastEvent | string | Последнее событие транзакции. Возвращается только если процесс истёк до того, как пользователь завершил поток. |
lastEventDescription | string | Описание lastEvent в удобочитаемом формате. Возвращается только если процесс истёк до того, как пользователь завершил поток. |
Поле state в полезных данных webhook использует префикс PROCESS_STATE_*. Это отдельный словарь, не связанный с полями result и status, возвращаемыми endpoint GetProcess, которые используют PROCESS_RESULT_*. Не используйте их как взаимозаменяемые.
Пример полезных данных
Завершено — успешно
{
"processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
"state": "PROCESS_STATE_FINISHED",
"flow": "humantoken"
}
Завершено — истёк срок действия
{
"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"
}
Перечень значений lastEvent
Полный список значений, которые могут присутствовать в lastEvent:
| Событие | Описание |
|---|---|
EVENT_TYPE_PROCESS_CREATED | Процесс создан |
EVENT_TYPE_PROCESS_STARTED_BY_USER | Процесс запущен пользователем |
EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED | Шаг проверки личности завершён |
EVENT_TYPE_SESSION_ENDED | Сессия завершена по тайм-ауту или в связи с созданием новой сессии |
Набор событий может расширяться. Относитесь к событиям, на которые реагирует ваш endpoint, как к конфигурации, а не к жёстко заданным константам — это позволит включать новые события без повторного развёртывания.
Получение полного результата процесса
Полезные данные webhook сигнализируют о завершении процесса, но не содержат сам результат. Чтобы получить результат — а также данные захвата, биометрические оценки, поля документа и т. д. — вызовите соответствующий endpoint GetProcess, см. Получение процесса.