Pular para o conteúdo principal

Eventos de Webhook

O sistema emite eventos para todas as operações significativas. Cada organização pode se inscrever nos tipos relevantes.

Formato do Payload​

{
"id": "9f8b2c14-3a5d-4e77-9b10-2c6e5f0a1d33",
"type": "payment.succeeded",
"created_at": "2026-04-05T10:30:00.000Z",
"data": { },
"changes": {
"status": { "from": "open", "to": "paid" }
},
"environment": "production",
"version": "2026-03-01"
}
  • id é o UUID do evento e created_at é ISO 8601 (UTC). Todos os campos do envelope usam snake_case.
  • data traz o recurso serializado no mesmo formato da API v1, também em snake_case.
  • changes é opcional: aparece nos eventos que carregam mudanças de campos (.db.updated e *.status_changed), no formato {"campo": {"from": valorAntigo, "to": valorNovo}}.

Tipos de Eventos​

Assinaturas (11 tipos)​

EventoDescrição
subscription.db.createdAssinatura criada
subscription.db.updatedAssinatura atualizada
subscription.db.deletedAssinatura deletada
subscription.status_changedStatus alterado
subscription.canceledCancelada
subscription.pausedPausada
subscription.resumedRetomada
subscription.renewedRenovada
subscription.trial_endingTrial prestes a expirar
subscription.past_dueEm atraso

Faturas (10 tipos)​

EventoDescrição
invoice.db.createdFatura criada
invoice.db.updatedFatura atualizada
invoice.db.deletedFatura deletada
invoice.status_changedStatus alterado
invoice.finalizedFinalizada
invoice.paidPaga
invoice.payment_failedPagamento falhou
invoice.voidedAnulada
invoice.uncollectibleMarcada como incobrável
invoice.overdueVencida

Pagamentos (8 tipos)​

EventoDescrição
payment.db.createdPagamento criado
payment.db.updatedPagamento atualizado
payment.db.deletedPagamento deletado
payment.status_changedStatus alterado
payment.processingEm processamento
payment.succeededBem-sucedido
payment.failedFalhou
payment.refundedReembolsado

Métodos de Pagamento (5 tipos)​

EventoDescrição
payment_method.db.createdMétodo criado
payment_method.db.updatedMétodo atualizado
payment_method.db.deletedMétodo removido
payment_method.status_changedStatus alterado
payment_method.expiredExpirado

Planos (4 tipos)​

EventoDescrição
plan.db.createdPlano criado
plan.db.updatedPlano atualizado
plan.db.deletedPlano deletado
plan.archivedPlano arquivado

Produtos (6 tipos)​

EventoDescrição
product.db.createdProduto criado
product.db.updatedProduto atualizado
product.db.deletedProduto deletado
product.status_changedStatus alterado
product.archivedArquivado
product.restoredRestaurado

Contas de Cobrança (5 tipos)​

EventoDescrição
billing_account.db.createdConta criada
billing_account.db.updatedConta atualizada
billing_account.db.deletedConta deletada
billing_account.status_changedStatus alterado
billing_account.suspendedConta suspensa

Empresa, Clientes e Outros​

  • company.db.created / db.updated / db.deleted / status_changed
  • customer.db.created / db.updated / db.deleted

Total: 56 tipos de eventos