Guia aprofundado sobre Webhooks, explicando como configurar a Quyta para notificar seus sistemas em tempo real sobre eventos importantes.

Introdução

Na integração tradicional via API, seu sistema precisa perguntar constantemente:
“Algo aconteceu?”
“Um pagamento foi feito?”
“Um acordo foi quebrado?”
Esse modelo se chama polling.
Embora funcione, ele é ineficiente, pois realiza diversas consultas desnecessárias.
Os Webhooks resolvem isso.
Em vez de seu sistema perguntar, a Quyta avisa automaticamente quando algo acontece.
É uma comunicação em tempo real, orientada a eventos.
Se a API é consulta, o Webhook é notificação.

Um Webhook é uma notificação automática enviada pela Quyta para uma URL do seu sistema sempre que um evento ocorre.
Ele funciona assim:
Evento acontece →
A Quyta monta um pacote de dados (payload) →
Envia para o seu endpoint →
Seu sistema executa uma ação.
Tudo em segundos.

Como Configurar um Webhook

Essa configuração normalmente é feita por um desenvolvedor.

1. Criar um Endpoint no Seu Sistema
Sua equipe técnica precisa criar uma URL pública, como:
https://seusistema.com/api/quyta-webhook
Essa URL deve:
Aceitar requisições HTTP POST
Receber dados em formato JSON
Executar lógica interna com base nesses dados

2. Acessar a área de Webhooks na Quyta
Vá até “Configurações” ou “Administração”.
Clique em “Webhooks” ou “Notificações de API”.

3. Criar um novo Webhook
Clique em “Adicionar Webhook”.
Preencha:
URL do Endpoint
Cole a URL criada pela sua equipe.
Eventos a serem monitorados
Selecione apenas os eventos relevantes.
Exemplos comuns:
parcela.paga
acordo.pago
acordo.quebrado
devedor.criado
Token de verificação (recomendado)
Defina um segredo para validar autenticidade.
Clique em “Salvar”.

A partir desse momento, o Webhook estará ativo.

Quando um evento selecionado acontece:
A Quyta identifica o evento.
Monta um payload em formato JSON.
Envia via POST para sua URL.
Seu sistema processa a informação.

Exemplo simplificado de payload:

{
"evento": "parcela.paga",
"cliente_id": "123",
"acordo_id": "456",
"valor": "150.00"
}
            

Seu sistema pode usar esses dados para:
Atualizar status no CRM
Registrar receita no ERP
Criar tarefa automática
Disparar e-mail de confirmação

Caso de Uso Prático

Cenário:
Sempre que uma parcela for paga, o CRM deve atualizar o status do cliente e gerar uma tarefa de acompanhamento.

Como implementar:
Desenvolvedor cria endpoint no CRM.
Administrador configura Webhook para evento “parcela.paga”.
Cliente paga via PIX.
Quyta envia notificação automaticamente.
CRM atualiza status para “Em Acordo”.
Tarefa é criada para time de relacionamento.

Resultado:
Dados sincronizados em tempo real
Zero intervenção manual
Experiência mais ágil para cliente

Sincronização imediata entre sistemas
Redução de carga em servidores
Automação reativa
Melhor experiência do cliente
Integração escalável
Eles permitem criar um ecossistema integrado, onde cada sistema reage automaticamente aos eventos financeiros.

Boas Práticas de Segurança

Sempre valide a assinatura do Webhook.
A Quyta pode enviar um cabeçalho de assinatura criptográfica.
Seu sistema deve:
Verificar a assinatura.
Confirmar autenticidade.
Processar apenas se válida.
Isso evita que terceiros enviem notificações falsas para seu endpoint.

Quando Usar API e Quando Usar Webhooks?

Use API quando precisar:
Buscar relatórios sob demanda
Consultar dados históricos
Executar ações manuais

Use Webhooks quando precisar:
Reagir imediatamente a eventos
Sincronizar sistemas
Criar automações em tempo real

Idealmente, os dois trabalham juntos.

Webhooks transformam sua operação de reativa para inteligente.
Eles eliminam atrasos, reduzem consumo de recursos e permitem automações avançadas entre múltiplos sistemas.
Se Tokens de API são a chave de acesso, Webhooks são o sistema de notificações.
Dominar essa funcionalidade eleva sua maturidade tecnológica e operacional.

🎉 Conclusão da Trilha de Conhecimento

Parabéns 👏
Você percorreu toda a jornada da plataforma Quyta:
Gestão de devedores
Acordos
Parcelamento
Configuração financeira
Governança de usuários
Integrações via API
Automação com Webhooks

Agora você está preparado para extrair o máximo valor da plataforma, automatizar processos e potencializar seus resultados.