VamPay
VamPay

Configurar webhooks

Defina a URL, gere o secret, teste a entrega e acompanhe o histórico pela API.

Antes de começar

Estes endpoints ficam em https://api.vampay.com.br/api/webhooks e usam o header X-API-Key. Os eventos enviados e o formato estão em Webhooks.

A URL precisa ser pública e segura. Endereços internos (localhost, redes privadas) são recusados com 400.

Definir a URL

PUT/api/webhooks/config
ParâmetroTipo
webhookUrlstring
webhookSecretstring
curlbash
curl -X PUT "https://api.vampay.com.br/api/webhooks/config" \
  -H "X-API-Key: vampay_sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "webhookUrl": "https://meusite.com/webhooks/vampay" }'

Responde { "success": true, "message": "Configuração atualizada" }.

Gerar um secret

POST/api/webhooks/generate-secret

Cria um secret novo e devolve em data.secret. Guarde: ele é a chave pra conferir a assinatura de cada entrega. Em apiKeyId você escolhe de qual chave é o secret; sem ele, vale o webhook geral da conta.

Testar a entrega

POST/api/webhooks/test

Envia um evento test pra sua URL, com a assinatura de verdade, e mostra o que aconteceu.

200 OKjson
{ "success": true, "data": { "url": "https://meusite.com/webhooks/vampay", "statusCode": 200, "responseTime": 184, "delivered": true } }

Se a sua URL não responder, vem delivered: false com o motivo em data.error. O tempo máximo de resposta é 10 segundos.

Histórico e reenvio

GET/api/webhooks/logs

Últimas entregas. Use ?limit= (até 100, padrão 50).

GET/api/webhooks/stats

Totais de entregas: total, success, failed e pending.

GET/api/webhooks/deliveries

Lista de entregas com os detalhes de cada tentativa.

POST/api/webhooks/deliveries/{id}/resend

Reenvia uma entrega específica.

POST/api/webhooks/deliveries/resend-failed

Reenvia de uma vez todas as entregas que falharam.