Skip to main content
Webhooks ajudam sua aplicação a acompanhar mudanças importantes sem precisar consultar a API o tempo todo. Quando um evento relevante acontece, a Veepag pode enviar um POST para a URL configurada em company.setting.webhook. Assim, seu sistema pode reagir a atualizações de transações, assinaturas e cobranças com mais agilidade.
ConfiguraçãoDescrição
activeIndica se o webhook está ativo.
urlURL que recebe os eventos por HTTP POST.

​
Eventos confirmados

EventoPayload
transaction.created{ "type": "transaction.created", "transaction": { ... } }
transaction.update{ "type": "transaction.update", "transaction": { ... } }
subscription.created{ "type": "subscription.created", "subscription": { ... } }
subscription.update{ "type": "subscription.update", "subscription": { ... } }
charge.created{ "type": "charge.created", "charge": { ... } }
charge.update{ "type": "charge.update", "charge": { ... } }
O payload de transação pode incluir dados relacionados como subscription, product, client e charge, quando disponíveis.

​
Exemplo de payload

{
  "type": "transaction.created",
  "transaction": {
    "_id": "transaction_id",
    "companyId": "company_id",
    "status": "PAID",
    "amount": 9900,
    "paymentMethod": "CREDIT_CARD",
    "createdAt": "2026-06-23T12:00:00.000Z",
    "lastUpdate": "2026-06-23T12:00:03.000Z"
  }
}

​
Boas práticas

  • Responda rapidamente com status 2xx quando receber o evento.
  • Registre o type e o identificador do recurso recebido.
  • Trate eventos de forma idempotente sempre que possível.
  • Consulte a API quando precisar confirmar o estado final de um recurso.
O provider atual envia um POST JSON simples para a URL configurada. Não há assinatura HMAC, verificação de webhook ou política de retry implementada nesse envio; erros de entrega são logados.
Se você estiver configurando webhooks pela primeira vez, recomendamos começar pelo sandbox e registrar os payloads recebidos. Isso facilita validar o fluxo com calma antes da homologação.