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 2 vezes, totalizando 3 tentativas. 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
10 minutos após a primeira
Em caso de falha na segunda tentativa, será agendado uma nova tentativa 10 minutos depois da segunda.
3
15 minutos após a segunda
Em caso de falha na terceira tentativa, será agendado uma nova tentativa 15 minutos depois da terceira.
Detectamos falha sempre que qualquer status fora do range (200,201,202 e 204) for retornado ou não detectarmos uma resposta em até 5 segundos.
Em caso de detecção de 10 erros consecutivos no envio do Webhook, o mesmo será pausado e nenhum evento será enviado até a ativação manual. Todos os eventos que acontecerem enquanto o webhook estiver pausado serão perdidos.
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#
