Webhooks e Eventos
Um webhook é um serviço de notificação sistêmica que permite a integração assíncrona entre sistemas — o Unico IDCloud notifica o seu backend sempre que um processo muda de estado, eliminando a necessidade de polling para verificar atualizações.
Esta seção aborda as quatro coisas que você precisa para integrar webhooks: como configurar o endpoint e a autenticação, os eventos que a Unico envia, a estratégia de fallback e os padrões de segurança e confiabilidade que o seu endpoint deve implementar.
Quando usar webhooks
Webhooks são a forma recomendada de ser notificado sobre a conclusão de processos. Eles são particularmente relevantes para:
- Human Token Journey (
humantoken,humantoken+revalidation) — para ser notificado quando o usuário conclui a jornada de um processo criado com Criar Processo. Os webhooks disparam apenas no estado terminal (PROCESS_STATE_FINISHED); nenhum evento de progresso intermediário é entregue. - Fluxos API Only (
api+humantoken,api+liveness+humantoken,api+liveness+humantoken+revalidation) — o resultado já vem na resposta de Criar Processo, então esses fluxos não dependem do webhook.
Webhooks complementam, mas não substituem, os endpoints GetProcess. Consulte Fallback.
Nesta seção
- Configuração — registro de endpoint, métodos de autenticação (OAuth2, Basic, API Key), configurações de retry.
- Tipos de evento — os eventos que a Unico envia e a estrutura do payload.
- Segurança — idempotência, limite de simultaneidade e taxa de erros.
- Fallback — como recuperar o resultado do processo quando o webhook não está disponível.