Guia de eventos de Webhook

O Dodo Payments emite eventos de webhook em cada etapa do ciclo de vida de um pagamento, assinatura, disputa, payout, crédito ou chave de licença. Esta página lista todos os eventos por recurso. Para ver os schemas completos de payload e exemplos de handlers, consulte as páginas específicas de cada recurso vinculadas abaixo.

Eventos de pagamento

Evento	É disparado quando
`payment.succeeded`	Um pagamento é processado com sucesso.
`payment.failed`	Uma tentativa de pagamento falha devido a cartões recusados, fundos insuficientes ou outros erros.
`payment.processing`	Um pagamento está sendo processado.
`payment.cancelled`	Um pagamento é cancelado antes da conclusão.

Para ver o schema completo do payload, consulte Webhooks de pagamento.

Eventos de reembolso

Evento	É disparado quando
`refund.succeeded`	Um reembolso é processado com sucesso.
`refund.failed`	Uma tentativa de reembolso falha devido a erros de processamento ou outros problemas.

Para ver o schema completo do payload, consulte Webhooks de reembolso.

Eventos de disputa

Evento	É disparado quando
`dispute.opened`	O titular do cartão abre uma disputa sobre um pagamento.
`dispute.challenged`	Evidências são enviadas para contestar a disputa.
`dispute.accepted`	A disputa é aceita sem ser contestada.
`dispute.cancelled`	A disputa é retirada ou cancelada.
`dispute.expired`	O prazo de resposta termina sem resolução.
`dispute.won`	A disputa é resolvida a seu favor.
`dispute.lost`	A disputa é resolvida a favor do titular do cartão.

Para ver schemas detalhados de payload e exemplos de handlers, consulte Webhooks de disputa.

Eventos de assinatura

Evento	É disparado quando
`subscription.active`	Uma assinatura é ativada com sucesso e as cobranças recorrentes são agendadas.
`subscription.updated`	Qualquer campo da assinatura é alterado (sincronização em tempo real sem polling).
`subscription.past_due`	Uma renovação falha e o período de carência é iniciado; o cliente mantém o acesso até o prazo final.
`subscription.on_hold`	Uma assinatura é temporariamente colocada em espera devido a uma renovação malsucedida.
`subscription.paused`	Uma assinatura é pausada.
`subscription.unpaused`	Uma assinatura pausada é retomada.
`subscription.renewed`	Uma assinatura é renovada com sucesso para o próximo período de cobrança.
`subscription.plan_changed`	Uma assinatura é atualizada, reduzida ou modificada com diferentes add-ons.
`subscription.update_payment_method`	O método de pagamento de uma assinatura é atualizado.
`subscription.cancelled`	Uma assinatura é cancelada pelo merchant ou pelo cliente.
`subscription.failed`	A criação da assinatura falha durante a criação do mandate.
`subscription.expired`	Uma assinatura chega ao fim do prazo e expira.

Para ver schemas detalhados de payload e exemplos de handlers, consulte Webhooks de assinatura.

Eventos de chave de licença

Evento	É disparado quando
`license_key.created`	Uma nova chave de licença é criada para um produto.

Para ver o schema completo do payload, consulte Webhooks de chave de licença.

Eventos de concessão de entitlement

Evento	É disparado quando
`entitlement_grant.created`	Uma nova concessão de entitlement é criada para um cliente. Concessões de chave de licença cumpridas automaticamente e concessões de feature flag chegam com `status: "Delivered"` e não disparam um evento `delivered` separado. Outras concessões, incluindo chaves de licença cumpridas manualmente, chegam `Pending`. Consulte Concessão de entitlement.
`entitlement_grant.delivered`	O cumprimento da concessão é concluído — a chave de licença é emitida, os links de arquivos são resolvidos ou o acesso à plataforma é concedido.
`entitlement_grant.failed`	O cumprimento da concessão falha. Verifique `error_code` e `error_message` no payload.
`entitlement_grant.revoked`	O acesso é revogado. Verifique `revocation_reason` no payload.

Para ver schemas detalhados de payload, eventos de exemplo e a referência completa de revocation_reason, consulte Webhooks de concessão de entitlement.

Eventos de crédito

Evento	É disparado quando
`credit.added`	Créditos são concedidos a um cliente (por assinatura, compra única, add-on ou API).
`credit.deducted`	Créditos são consumidos por uso ou débito manual.
`credit.expired`	Créditos não utilizados expiram após o período de expiração configurado.
`credit.rolled_over`	Créditos não utilizados são transferidos para uma nova concessão no fim do ciclo.
`credit.rollover_forfeited`	Créditos são perdidos porque a quantidade máxima de rollovers foi atingida.
`credit.overage_charged`	Cobranças por excesso de uso são aplicadas quando o uso ultrapassa o saldo zero.
`credit.overage_reset`	As cobranças por excesso de uso acumuladas são redefinidas (por exemplo, no início de um novo ciclo de cobrança).
`credit.manual_adjustment`	Um ajuste manual de crédito ou débito é realizado.
`credit.balance_low`	O saldo de crédito fica abaixo do limite configurado.

Para ver schemas detalhados de payload e exemplos de handlers, consulte Webhooks de cobrança baseada em crédito.

Eventos de recuperação

Evento	É disparado quando
`abandoned_checkout.detected`	Um checkout incompleto ou malsucedido é detectado após 60 minutos.
`abandoned_checkout.recovered`	Um cliente conclui o pagamento por meio de um link de recuperação.

Para ver schemas detalhados de payload, descrições de campos e exemplos de handlers, consulte Webhooks de recuperação.

Eventos de dunning

Evento	É disparado quando
`dunning.started`	Uma tentativa de dunning começa para uma assinatura que ficou vencida ou em espera, ou que foi cancelada.
`dunning.recovered`	Um cliente atualiza o método de pagamento e a cobrança resultante é bem-sucedida.

Para ver schemas detalhados de payload, descrições de campos e exemplos de handlers, consulte Webhooks de recuperação.

Eventos de payout

Os eventos de payout acompanham a movimentação dos seus fundos do Dodo Payments para sua conta bancária. Eles refletem os status de payout exibidos no dashboard. O payload é um objeto de payout com o mesmo formato de uma entrada de GET /payouts.

Evento	É disparado quando
`payout.created`	Um payout é criado, seja pelo ciclo automático de payouts ou fora do ciclo.
`payout.in_progress`	A data de vencimento do payout chega e o processamento começa.
`payout.on_hold`	Um payout é pausado ou colocado em análise.
`payout.success`	O payout para sua conta bancária é liquidado.
`payout.failed`	Um payout falha. Os fundos e as taxas são creditados novamente na sua wallet.

Os eventos de payout não são terminais nem seguem uma ordem estrita. payout.failed pode chegar depois de payout.success quando um banco devolve a transferência, e payout.success pode chegar depois de payout.failed quando um payout com falha é recuperado posteriormente. O status do payload sempre corresponde ao tipo de evento; portanto, use o timestamp de nível superior de cada evento para encontrar o estado mais recente.

payout.created era emitido anteriormente como payout.not_initiated. Se um endpoint existente filtra por payout.not_initiated, atualize o filtro para payout.created para que ele continue correspondendo.

Para ver schemas detalhados de payload, descrições de campos e exemplos de handlers, consulte Webhooks de payout.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Eventos de pagamento

Eventos de reembolso

Eventos de disputa

Eventos de assinatura

Eventos de chave de licença

Eventos de concessão de entitlement

Eventos de crédito

Eventos de recuperação

Eventos de dunning

Eventos de payout

​Eventos de pagamento

​Eventos de reembolso

​Eventos de disputa

​Eventos de assinatura

​Eventos de chave de licença

​Eventos de concessão de entitlement

​Eventos de crédito

​Eventos de recuperação

​Eventos de dunning

​Eventos de payout

Eventos de pagamento

Eventos de reembolso

Eventos de disputa

Eventos de assinatura

Eventos de chave de licença

Eventos de concessão de entitlement

Eventos de crédito

Eventos de recuperação

Eventos de dunning

Eventos de payout