Visão Geral da Arquitetura de Webhooks

A plataforma de Credit as a Service (CaaS) da Open Co possibilita a integração por meio de webhooks, permitindo comunicação eficiente e em tempo real sobre eventos relevantes do fluxo de crédito.

Funcionamento dos Webhooks

Todos os eventos gerados pela plataforma são enviados automaticamente para uma URL previamente cadastrada e autorizada em nossa plataforma. Este mecanismo garante que as notificações cheguem com segurança ao ambiente do parceiro, sempre que um evento de interesse ocorrer.

Principais Características

URL Única e Pré-Cadastrada: Todos os webhooks são enviados para a URL previamente registrada durante o processo de integração. O envio da URL a ser cadastrada deve ser realizado por e-mail para [email protected] contendo as seguintes informações:
- Nome da empresa
- CNPJ
- URL do webhook
- Nome do responsável
- E-mail do responsável
  O cadastro da URL será feito de forma segura por nossa equipe.
Criptografia SSL: Todas as chamadas de webhook utilizam criptografia SSL para garantir a confidencialidade e integridade dos dados transmitidos.
Segurança: As URLs receptoras devem implementar práticas de validação e autenticação, garantindo que apenas requisições legítimas sejam aceitas.
Eventos Cobertos: Os webhooks são acionados em todas as etapas do empréstimo, sempre que ocorre qualquer movimentação, o que proporciona acompanhamento detalhado e em tempo real do status e avanços do fluxo.
Formato de Envio: Os dados são transmitidos em formato JSON, contendo detalhes do evento ocorrido.
Mitigação de Throttling: A arquitetura de webhooks elimina os riscos de throttling na API, pois todas as notificações são entregues de forma proativa pelo sistema.

Fluxo Básico

Cadastro da URL: O parceiro informa a URL que receberá as notificações de webhook enviando os dados necessários por e-mail para [email protected].
Lista de IPs para Allow List: A Open fornece uma lista de IPs de origem das chamadas dos webhooks para cadastro em Allow Lists de Firewalls e WAFs.
Gatilho de Evento: A cada evento relevante, em qualquer etapa do empréstimo, a plataforma envia automaticamente uma requisição HTTP POST para a URL cadastrada, utilizando SSL.
Recebimento e Processamento: O sistema do parceiro recebe e processa a notificação de acordo com sua necessidade de negócio.

Recomendações

Certifique-se de que a URL esteja sempre acessível e que haja tratamento apropriado para requisições simultâneas.
Implemente respostas HTTP adequadas para confirmar o recebimento dos eventos.
Para máxima segurança e rastreabilidade, recomenda-se o uso de logs e validação de origem das requisições.
Realize o tratamento dos webhooks de forma assíncrona para evitar gargalos e perda de eventos.

Em caso de dúvidas técnicas sobre webhooks ou para alteração da URL informada, entre em contato com o nosso time de suporte técnico.