O webhook, também conhecido como callback, é um recurso que permite o envio de informações sempre que um determinado evento acontece.Dentro das APIs da Bankerize, esse recurso funciona de forma automática: sempre que ocorrem eventos específicos no sistema, um webhook é disparado para informar a atualização.Esse processo tem como objetivo manter o parceiro informado sobre mudanças no status das propostas, sem que seja necessário realizar consultas frequentes para acompanhar essas alterações.Dessa forma, as informações chegam de forma instantânea e automática, sem que o parceiro precise fazer qualquer requisição manual para obter essas atualizações.Nesta seção sobre Webhooks, você encontrará uma explicação detalhada sobre como esse mecanismo opera, sua relevância nas integrações e como aplicá-lo no desenvolvimento da sua solução utilizando as APIs da Bankerize.Notificação#
Vamos enviar um payload contendo os dados relacionados ao fato ocorrido imediatamente. Porém, em caso de falha no recebimento dessa notificação, ainda tentaremos mais 5 vezes. As tentativas são feitas da seguinte forma:1
Após a ocorrência de um evento
Assim que acontecer um evento mapeado para disparo de webhook, será adicionado a fila de envio para notificação ao parceiro.
2
1 minuto após a primeira tentativa
Em caso de falha na primeira tentativa, será agendado uma nova tentativa 1 minuto depois da primeira.
3
1 minuto e 30 segundos após a segunda
Em caso de falha na segunda tentativa, será agendado uma nova tentativa 1 minuto e 30 segundos depois da segunda.
4
2 minutos após a terceira
Em caso de falha na terceira tentativa, será agendado uma nova tentativa 2 minutos depois da terceira.
5
Mais 2 tentativas finais
Os agendamentos são feitos aumentando em 30 segundos o tempo da tentativa anterior toda vez que o envio falha.
Detectamos falha sempre que qualquer status fora do range 2xx for devolvido para gente ou não detectarmos uma resposta em até 5 segundos.
Estrutura do payload#
A estrutura do payload que será enviado pelo webhook segue sempre a mesma, independente do fato ocorrido. As únicas coisas que irão mudar, são os valores.
A estrutura do payload é essa:É de extrema importância que entenda que somente a estrutura do json se mantem (event, key, payload) os valores deles mudam de acordo com o contexto do fato ocorrido.
Exemplos de retorno#
