Webhook de parcelas aprovadas

Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de parcelas aprovadas. Este módulo serve para integrar sistemas de terceiros com a baixa de parcelas de acordo no Recuperador CRM.

Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a parcela de acordo aprovada. Isso permitirá com que o sistema de terceiros faça alguma ação, tais como cadastrar uma fatura, liberar um bloqueio, remover uma negativação etc.

Dica: sistema de terceiros é um sistema feito por outra empresa, diferente da empresa responsável pelo Recuperador CRM, que receberá as informações da parcela aprovada. Esse sistema de terceiros pode ser um sistema de gestão, pode ser um sistema próprio etc.

Configuração inicial

O primeiro passo é habilitar o webhook de parcelas aprovadas no cadastro do credor em questão. Isso pode ser feito logado como administrador (assessoria) por meio do menu Cadastros > Credores > aba Webhooks. Mude o campo HABILITA WEBHOOK DE PARCELAS APROVADAS para Sim, defina o endereço do endpoint do sistema de terceiros e clique em Salvar.

Importante: o endpoint do webhook de parcelas aprovadas deve ser obtido com o suporte do seu sistema de terceiros. Ele deve começar com http ou https.

Locais de disparo do webhook de parcelas aprovadas

Os webhooks de parcelas aprovadas serão disparados automaticamente sempre que:

1. Uma parcela de acordo for aprovada automaticamente na Zoop;
2. Uma parcela de acordo for aprovada automaticamente na Pagar.me;
3. Uma parcela de acordo for aprovada automaticamente no retorno de boletos próprios;
4. Uma parcela de acordo for baixada manualmente;

Além disso, o sistema fará uma retentativa diária de disparo de webhooks não processados nos últimos 7 dias na parte da manhã. O sistema faz até 5 tentativas de envio de webhook de uma parcela aprovada para o sistema de terceiros.

Relatório

Em Cadastros > Credores > aba Webhooks > botão Lista de payloads de parcelas aprovadas, é possível consultar os disparos dos webhooks de parcelas aprovadas por período e o status do envio por meio da coluna Enviado.

Além disso, é possível usar o botão Reprocessar para forçar o envio dos webhooks de parcelas aprovadas um determinado período que eventualmente não foram enviadas. Isso pode ser especialmente útil em caso de queda temporária do sistema de terceiros.

Lista de payloads de parcelas aprovadas com destaque para a coluna Enviado e botão Reprocessar