Recaudo Docs

Configuración

Webhooks

Avise seus outros sistemas no momento em que algo acontece no Recaudo: um pagamento, um cliente novo, uma conversa atribuída.

Antes de começar

Você precisa de um endereço https no seu sistema que receba requisições POST com JSON. Os webhooks ficam em Configurações › Avançado › Webhooks (página Avisos para seus sistemas).

Adicionar um endereço

Cada endereço recebe só os eventos que você escolher.

  1. Abra Webhooks

    Acesse Configurações, abra Avançado, escolha Webhooks e clique em Novo endereço.
  2. Informe para onde avisar

    Em Para onde avisar cole o Endereço web (deve começar com https) e, se quiser, um nome ou nota. Deixe marcado Enviar avisos para este endereço.
  3. Escolha o que avisar

    Em O que avisar marque os eventos que interessam ou use Selecionar todos.
  4. Salve e copie a chave de assinatura

    Clique em Salvar endereço. Aparece Guarde sua chave de assinatura (começa com whsec_): copie para o seu sistema.
  5. Envie um teste

    Use Enviar teste para receber um aviso test.webhook e confirmar que seu sistema responde.

Eventos disponíveis

Os eventos são agrupados por módulo. Alguns exemplos:

  • Pagamentos e links de pagamento: payment.succeeded, payment.failed, payment_link.paid.
  • Faturas e assinaturas: invoice.paid, subscription.canceled.
  • Clientes e leads: customer.created, lead.converted.
  • Conversas: conversation.assigned, conversation.message.received.
  • CRM, acompanhamentos e fluxos: deal.won, follow_up.completed, flow_run.completed.

Verificar a assinatura

Cada aviso traz o cabeçalho X-Recaudo-Signature com o horário (t) e uma assinatura HMAC-SHA256 (v1) de t.corpo feita com sua chave de assinatura. Calcule você mesmo e compare antes de confiar no aviso:

X-Recaudo-Signature: t=1760000000,v1=5f2b9c...
X-Recaudo-Event-Id: 9b1d2c3e-...
X-Recaudo-Event-Type: payment.succeeded

A estrutura de cada evento está na referência de webhooks da API.

Revisar envios e reenviar

Seu sistema deve responder com um código 2xx. Se não responder ou falhar, o Recaudo tenta de novo até 5 vezes, com esperas cada vez maiores.

  1. Abra o detalhe

    Na lista de endereços clique em Ver detalhe.
  2. Confira Envios recentes

    Cada envio aparece como Recebido, Com falha ou Pendente, com o número da tentativa, os dados enviados e a resposta do seu sistema.
  3. Reenvie se precisar

    Depois de corrigir o problema no seu sistema, use Reenviar no envio que falhou.

Dica

Use X-Recaudo-Event-Id para ignorar avisos repetidos: por causa das novas tentativas, o mesmo evento pode chegar mais de uma vez.

Próximo passo

Esta página ajudou? Obrigado por avisar.
Esc