Skip to main content

​
Webhooks

Configure webhooks para receber notificações em tempo real sobre eventos importantes.
Para um guia completo sobre Webhooks, consulte Webhooks Guide.

​
Listar Assinaturas

curl -X GET "https://https://upay-sistema-api.onrender.com//api/webhooks/subscriptions" \
  -H "Authorization: Bearer SUA_API_KEY"

​
Criar Assinatura

curl -X POST "https://https://upay-sistema-api.onrender.com//api/webhooks/subscriptions" \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://meusite.com.br/webhooks/upay",
    "events": ["payment.completed", "payment.failed"],
    "description": "Webhook para notificações de pagamento"
  }'
​
url
string
required
URL do endpoint que receberá os webhooks
​
events
array
required
Array de eventos para assinar:
  • payment.completed
  • payment.failed
  • payment.pending
  • payment.refunded
  • payment.cancelled
  • payment_link.created
  • payment_link.updated
  • payment_link.deleted
  • product.created
  • product.updated
  • product.deleted
  • coupon.created
  • coupon.used
  • coupon.expired
​
description
string
Descrição da assinatura
​
success
boolean
Indica se a requisição foi bem-sucedida
​
data
object
Dados da assinatura criada, incluindo o secret para validação
Guarde o secret em local seguro. Ele será usado para validar as requisições do webhook usando HMAC-SHA256.

​
Listar Eventos

curl -X GET "https://https://upay-sistema-api.onrender.com//api/webhooks/events?page=1&limit=20" \
  -H "Authorization: Bearer SUA_API_KEY"

​
Atualizar Assinatura

curl -X PUT "https://https://upay-sistema-api.onrender.com//api/webhooks/subscriptions/{id}" \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://meusite.com.br/webhooks/upay-v2",
    "events": ["payment.completed", "payment.failed", "payment.refunded"],
    "status": "ACTIVE"
  }'

​
Deletar Assinatura

curl -X DELETE "https://https://upay-sistema-api.onrender.com//api/webhooks/subscriptions/{id}" \
  -H "Authorization: Bearer SUA_API_KEY"

​
Validação de Webhooks

Todas as requisições de webhook incluem o header X-Upay-Signature com uma assinatura HMAC-SHA256. Use o secret da assinatura para validar que a requisição veio da UPay.

Guia Completo

Aprenda mais sobre Webhooks e validação