Melhores práticas

Implemente essas práticas recomendadas ao usar webhooks.

Os webhooks fornecem um método poderoso para rastrear o estado das transações e realizar ações em sua conta Base39. Revise essas práticas recomendadas para garantir que seus webhooks permaneçam seguros e funcionem perfeitamente com sua integração.

Tipos de eventos

Seu endpoint do webhook deve ser configurados para receber apenas os tipos de eventos exigidos por sua integração. Ouvir eventos extras (ou todos os eventos) irá colocar pressão desnecessária em seu servidor e não é recomendado.

Tentativas e novas tentativas de entrega

Entenda como visualizar as tentativas de entrega, logs de eventos e a lógica de tentativa quando os eventos do webhook não são reconhecidos.

Lógica de tentativa
A Base39 tenta novamente três vezes em alguns minutos. Os webhooks não podem ser repetidos manualmente.

Tratamento de eventos

O tratamento correto dos eventos de webhook é crucial para garantir que a lógica de negócios da integração funcione conforme o esperado.

Lidar com eventos duplicados
Os endpoints de webhook podem ocasionalmente receber o mesmo evento mais de uma vez. Aconselhamos você a se proteger contra recibos de eventos duplicados, tornando o processamento de seu evento [idempotente] (https://en.wikipedia.org/wiki/Idempotence). Uma maneira de fazer isso é registrar os eventos que você processou e, em seguida, não processar os eventos já registrados.

Ordem dos eventos
A Base39 não garante a entrega dos eventos na ordem em que são gerados. Por exemplo, a criação de um empréstimo pode gerar os seguintes eventos:

  • account.created
  • loan.created
  • notification.email.sent
    Seu endpoint não deve esperar a entrega desses eventos nesta ordem e deve lidar com isso de acordo.

Segurança

Manter seus endpoints seguros é fundamental para proteger as informações de seus clientes.

Receba eventos com um servidor HTTPS
Se você usar uma URL HTTPS para o endpoint do webhook, a Base39 validará se a conexão com o seu servidor é segura antes de enviar os dados do webhook. Para que isso funcione, seu servidor deve estar configurado corretamente para suportar HTTPS com um certificado de servidor válido. URLs HTTPS são obrigatórias.