Вебхуки и события

Вебхук — это системный сервис уведомлений, обеспечивающий асинхронную интеграцию между системами: Unico IDCloud уведомляет ваш бэкенд каждый раз, когда процесс меняет состояние, поэтому вам не нужно регулярно опрашивать сервис на предмет обновлений.

В этом разделе рассматриваются четыре вещи, необходимые для интеграции вебхуков: как настроить эндпоинт и аутентификацию, события, которые отправляет Unico, стратегия резервного варианта, а также паттерны безопасности и надёжности, которые должен реализовывать ваш эндпоинт.

Когда использовать вебхуки

Вебхуки — рекомендуемый способ получения уведомлений о завершении процессов. Они особенно актуальны для:

• Визуальных потоков (SDK / Web Redirect / iFrame) — чтобы знать, когда пользователь завершает сценарий.
• Асинхронных потоков Web и SDK — чтобы получать уведомление об окончании обработки POST /client/v1/process на стороне Unico.
• Длительных потоков, объединяющих несколько возможностей (например, анализ документов + ручная проверка). Вебхуки срабатывают только при достижении конечного состояния (PROCESS_STATE_FINISHED); промежуточные события о ходе выполнения не отправляются.

Вебхуки дополняют, но не заменяют эндпоинты GetProcess. См. Резервный вариант.

В этом разделе

• Настройка — регистрация эндпоинта, методы аутентификации (OAuth2, Basic, API Key), настройки повторных попыток.
• Типы событий — события, которые отправляет Unico, и структура полезной нагрузки.
• Безопасность — идемпотентность, ограничение параллелизма и частота ошибок.
• Резервный вариант — как получить результат процесса при недоступности вебхука.