Webhooks
Receber avisos automáticos quando algo acontece.
Webhooks são avisos automáticos que o sistema envia para um endereço seu quando algo acontece, por exemplo quando uma proposta é aprovada. Não há uma tela dedicada nas Configurações para isso, a configuração e feita por API.
Como configurar
- 1Gere uma chave de API em Configurações, aba API (veja o artigo Chaves de API).
- 2Faça uma requisição POST para /api/v1/webhooks informando a URL que vai receber os avisos e a lista de eventos desejados.
- 3Guarde o segredo (secret) retornado: ele é usado para confirmar que o aviso realmente veio do Connect Close.
- 4No seu servidor, confira o header X-Webhook-Signature (no formato sha256=...), calculado como HMAC-SHA256 do corpo da requisição usando o segredo.
Eventos disponíveis
- proposal.created: uma proposta foi criada.
- proposal.updated: dados de uma proposta foram alterados.
- proposal.sent: uma proposta foi enviada ao cliente.
- proposal.approved: uma proposta foi aprovada (aceite interno).
- proposal.signed: uma proposta foi assinada digitalmente.
- proposal.signature_refused: o cliente recusou a assinatura.
- proposal.expired: uma proposta passou da validade.
- proposal.cancelled: uma proposta foi cancelada.
- client.created: um cliente foi criado.
- client.updated: dados de um cliente foram alterados.
Observação
Se a entrega falhar, o sistema tenta de novo automaticamente: após 5 minutos, depois 30 minutos, depois 2 horas. Depois de 3 tentativas sem sucesso, a entrega fica marcada como falha.
Documentação técnica completa da APIExemplos de payload de cada evento e como gerenciar assinaturas de webhook.
