Eventos do webhook
Este guia oferece uma visão detalhada dos eventos gerados pelo fluxo de esteira, que podem ser empregados em integrações ou em fluxos de desenvolvimento low-code/no-code, como o Zapier e Pipedream.
Para instruções adicionais sobre como se inscrever e receber estes eventos, por favor consulte o Guia de Webhooks para desenvolvedores.
Ao criar um empréstimo que inclui várias etapas da esteira, um evento step.created será emitido para cada uma dessas etapas.
Inicialmente, todas as etapas são criadas com o status "pendente" e podem transitar para "em progresso" ou "concluído" pouco tempo depois. Esta transição ocorre devido a um processo de verificação automática que é ativado por certos eventos, como a criação ou atualização de um empréstimo. Este processo de verificação ocorre em segundo plano e pode levar alguns segundos para ser concluído. Cada tipo de etapa é desencadeado por um conjunto específico de eventos.
Evento: Criação da etapa
step.created - Ocorre quando uma etapa é inicialmente criada no processo de empréstimo, indicando que ela foi gerada, mas ainda não foi processada.
Evento: Início da verificação
step.started - Ocorre quando uma verificação é ativada. Neste ponto, o status da etapa pode mudar para "em progresso" (in_progress) ou "falha" (failed). É possível que algumas verificações sejam finalizadas imediatamente, sem passar pelo status "em progresso" (in_progress).
Exemplos:
- Se um empréstimo já possui uma assinatura de um operador de backoffice antes da etapa de assinatura entrar em "em progresso" (
in_progress), ela será imediatamente marcada como concluída. - Da mesma forma, uma etapa de verificação de identidade pode ser marcada como concluída com base em documentos enviados anteriormente, desde que atendam aos critérios de validade. Para mais informações, consulte a Configuração de Validade de Documentos.
O ato de assinar o empréstimo pode ser executado pelo cliente, operador de backoffice ou pela empresa. A plataforma interpreta a assinatura como uma aprovação.
Evento: Marcado como em progresso
step.marked_in_progress - Ocorre quando todas as dependências foram atendidas ou se não existem dependências, indicando que a etapa está esperando um retorno de concluído ou falha.
Exemplos:
- Uma etapa denominada "Averbação da Empresa" entra em "em progresso" quando um operador da empresa precisa assinar o empréstimo para concluir a etapa.
Evento: Marcado como concluído
step.marked_done - Ocorre quando todas as verificações e confirmações foram realizadas com sucesso, alterando o status da etapa para "concluído".
Evento: Marcado como falha
step.marked_failed - Pode ser publicado por diversas razões. Detalhes adicionais podem ser encontrados na documentação específica para cada tipo de etapa.
Exemplo:
- Se um operador da empresa recusa a averbação, a etapa "Averbação da Empresa" é marcada como "falha".
Evento: concluído
step.fulfilled - Ocorre quando todas as etapas do fluxo foram concluídas com sucesso.
Caso necessite marcar uma etapa como "falha", isso pode ser realizado através do endpoint de atualização da etapa da esteira.