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.
400.Definir a URL
/api/webhooks/config| Parâmetro | Tipo | Descrição |
|---|---|---|
webhookUrl | string | URL que vai receber os eventos. Envie vazio pra remover |
webhookSecret | string | Secret usado na assinatura. Vazio = usa a API Key |
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
/api/webhooks/generate-secretCria 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
/api/webhooks/testEnvia um evento test pra sua URL, com a assinatura de verdade, e mostra o que aconteceu.
{ "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
/api/webhooks/logsÚltimas entregas. Use ?limit= (até 100, padrão 50).
/api/webhooks/statsTotais de entregas: total, success, failed e pending.
/api/webhooks/deliveriesLista de entregas com os detalhes de cada tentativa.
/api/webhooks/deliveries/{id}/resendReenvia uma entrega específica.
/api/webhooks/deliveries/resend-failedReenvia de uma vez todas as entregas que falharam.
