Guia de Eventos de Webhook - Dodo Payments Documentation

O Dodo Payments fornece notificações de webhook em tempo real para mantê-lo informado sobre eventos críticos relacionados a transações, assinaturas, reembolsos, disputas e gerenciamento de chaves de licença. Abaixo está um guia detalhado para esses eventos, categorizados para clareza, juntamente com dicas e considerações de implementação.

Eventos de Pagamento

Nome do Evento	Tipo de Evento	Descrição
Payment Succeeded	`payment.succeeded`	Acionado quando um pagamento é processado com sucesso.
Payment Failed	`payment.failed`	Ocorre quando uma tentativa de pagamento falha devido a erros, cartões recusados ou outros problemas.
Payment Processing	`payment.processing`	Indica que um pagamento está sendo processado no momento.
Payment Cancelled	`payment.cancelled`	Acionado quando um pagamento é cancelado antes da conclusão.

Eventos de Reembolso

Nome do Evento	Tipo de Evento	Descrição
Refund Succeeded	`refund.succeeded`	Acionado quando um reembolso é processado com sucesso.
Refund Failed	`refund.failed`	Ocorre quando uma tentativa de reembolso falha devido a erros de processamento ou outros problemas.

Eventos de Disputa

Nome do Evento	Tipo de Evento	Descrição
Dispute Opened	`dispute.opened`	Acionado quando um cliente inicia uma disputa.
Dispute Expired	`dispute.expired`	Indica que uma disputa expirou sem resolução.
Dispute Accepted	`dispute.accepted`	Acionado quando um comerciante aceita a disputa.
Dispute Cancelled	`dispute.cancelled`	Ocorre quando uma disputa é cancelada pelo cliente ou pelo sistema.
Dispute Challenged	`dispute.challenged`	Acionado quando um comerciante contesta uma disputa.
Dispute Won	`dispute.won`	Indica que o comerciante venceu com sucesso uma disputa.
Dispute Lost	`dispute.lost`	Ocorre quando o comerciante perde uma disputa.

Eventos de Assinatura

Nome do Evento	Tipo de Evento	Descrição
Subscription Active	`subscription.active`	Indica que uma assinatura está agora ativa e cobranças recorrentes estão agendadas.
Subscription Updated	`subscription.updated`	Acionado quando qualquer campo de assinatura é atualizado (sincronização em tempo real sem polling).
Subscription On Hold	`subscription.on_hold`	Acionado quando uma assinatura é temporariamente suspensa devido à falha na renovação.
Subscription Renewed	`subscription.renewed`	Ocorre quando uma assinatura é renovada com sucesso.
Subscription Plan Changed	`subscription.plan_changed`	Acionado quando uma assinatura é atualizada, rebaixada ou modificada com addons diferentes.
Subscription Cancelled	`subscription.cancelled`	Acionado quando uma assinatura é cancelada pelo comerciante ou cliente.
Subscription Failed	`subscription.failed`	Indica uma assinatura falhada. Isso significa que não conseguimos criar um mandato.
Subscription Expired	`subscription.expired`	Acionado quando uma assinatura chega ao fim do seu período e expira.

Eventos de Chave de Licença

Nome do Evento	Tipo de Evento	Descrição
License Key Created	`license_key.created`	Acionado quando uma nova chave de licença é criada para um produto.

Eventos de Concessão de Direitos

Nome do Evento	Tipo de Evento	Descrição
Grant Created	`entitlement_grant.created`	Uma nova concessão de direitos é criada para um cliente. Concessões de chave de licença chegam `delivered`; concessões baseadas em OAuth (Discord, GitHub, Notion) chegam `pending`.
Grant Delivered	`entitlement_grant.delivered`	O cumprimento da concessão é concluído — chave de licença emitida, links de arquivo resolvidos ou acesso à plataforma concedido.
Grant Failed	`entitlement_grant.failed`	O cumprimento da concessão falhou; inspeccionar `error_code` e `error_message`.
Grant Revoked	`entitlement_grant.revoked`	Acesso retirado; inspecionar `revocation_reason` (estado da assinatura, reembolso, mudança de plano ou manual).

Para esquemas de payload detalhados, eventos de exemplo e referência completa revocation_reason, veja Webhooks de Concessão de Direitos.

Eventos de Crédito

Nome do Evento	Tipo de Evento	Descrição
Crédito Adicionado	`credit.added`	Acionado quando créditos são concedidos a um cliente (assinatura, única vez, complementar ou API).
Crédito Deduzido	`credit.deducted`	Ocorre quando créditos são consumidos por uso ou débito manual.
Crédito Expirado	`credit.expired`	Acionado quando créditos não utilizados expiram após o período de expiração configurado.
Crédito Transferido	`credit.rolled_over`	Ocorre quando créditos não utilizados são transferidos para uma nova concessão no final do ciclo.
Rollover Perdido	`credit.rollover_forfeited`	Acionado quando créditos são perdidos porque o número máximo de transferências foi atingido.
Cobrança por Excesso	`credit.overage_charged`	Ocorre quando cobranças por excesso são aplicadas por uso além do saldo zero.
Excesso Reiniciado	`credit.overage_reset`	Acionado quando cobranças acumuladas por excesso são reiniciadas (por exemplo, no início de um novo ciclo de cobrança).
Ajuste Manual	`credit.manual_adjustment`	Acionado quando é feito um ajuste manual de crédito ou débito.
Saldo Baixo	`credit.balance_low`	Acionado quando o saldo de crédito cai abaixo do limite configurado.

Eventos de Recuperação

Nome do Evento	Tipo de Evento	Descrição
Abandoned Checkout Detected	`abandoned_checkout.detected`	Acionado quando um checkout incompleto ou falhado é detectado após 60 minutos.
Abandoned Checkout Recovered	`abandoned_checkout.recovered`	Ocorre quando um cliente completa o pagamento através de um link de recuperação.

Para esquemas de payload detalhados, descrições de campos e exemplos de manipuladores, consulte Webhooks de Recuperação.

Eventos de Cobrança

Nome do Evento	Tipo de Evento	Descrição
Dunning Started	`dunning.started`	Acionado quando uma tentativa de cobrança começa para uma assinatura que foi suspensa ou cancelada.
Dunning Recovered	`dunning.recovered`	Ocorre quando um cliente atualiza seu método de pagamento e a cobrança resultante tem sucesso.

Para esquemas de payload detalhados, descrições de campos e exemplos de manipuladores, veja Webhooks de Recuperação. Esses eventos de webhook são projetados para fornecer aos comerciantes atualizações críticas para gerenciar suas operações de forma eficaz. Implemente manipuladores robustos para cada evento relevante em sua integração de webhook para garantir funcionalidade suave e confiável.

​Eventos de Pagamento

​Eventos de Reembolso

​Eventos de Disputa

​Eventos de Assinatura

​Eventos de Chave de Licença

​Eventos de Concessão de Direitos

​Eventos de Crédito

​Eventos de Recuperação

​Eventos de Cobrança