Recuperação

Eventos de Recuperação de Carrinho Abandonado

Os seguintes eventos de webhook rastreiam o ciclo de vida da recuperação de carrinho abandonado:

Evento	Descrição
`abandoned_checkout.detected`	Um checkout abandonado foi detectado. Enviado quando um pagamento é identificado como abandonado (falhou ou está incompleto) e o fluxo de trabalho de recuperação começa.
`abandoned_checkout.recovered`	O cliente completou o pagamento através do link de recuperação. O campo `recovered_payment_id` contém o ID do pagamento bem-sucedido.

Campos de Payload de Checkout Abandonado

string

obrigatório

O pagamento original que foi abandonado. Use isso para procurar detalhes de produto, valor e moeda.

string

obrigatório

A marca à qual este checkout abandonado pertence.

string

obrigatório

O cliente que abandonou o checkout.

string

obrigatório

Por que o checkout foi abandonado. Uma das opções:

payment_failed — O cliente tentou efetuar o pagamento, mas ele falhou
checkout_incomplete — O cliente visitou o checkout, mas nunca tentou efetuar o pagamento

string

obrigatório

Estado atual do ciclo de vida desta tentativa de recuperação. Uma das opções:

abandoned — Detectado, nenhum e-mail enviado ainda
recovering — Pelo menos um e-mail de recuperação enviado
recovered — O cliente concluiu o pagamento
exhausted — Todos os e-mails enviados ou um checkout mais recente encontrado
opted_out — O cliente cancelou a inscrição

string

obrigatório

Timestamp ISO 8601 de quando o checkout foi detectado como abandonado.

string | null

O ID do pagamento de recuperação bem-sucedido. null até que o checkout seja recuperado.

Exemplo: processando Webhooks ACR

app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;

  switch (event.type) {
    case 'abandoned_checkout.detected':
      console.log(`Checkout abandoned: ${event.data.payment_id}`);
      console.log(`Reason: ${event.data.abandonment_reason}`);
      // Track abandonment in your analytics
      await trackAbandonment(event.data);
      break;

    case 'abandoned_checkout.recovered':
      console.log(`Checkout recovered: ${event.data.payment_id}`);
      console.log(`Recovery payment: ${event.data.recovered_payment_id}`);
      // Grant access, update records
      await handleRecovery(event.data);
      break;
  }

  res.json({ received: true });
});

Eventos de dunning

Os seguintes eventos de webhook acompanham o ciclo de vida de dunning da assinatura:

Evento	Descrição
`dunning.started`	Uma tentativa de dunning foi criada para uma assinatura que entrou em `on_hold` ou foi cancelada pelo cliente.
`dunning.recovered`	O cliente atualizou seu método de pagamento e o pagamento resultante foi bem-sucedido. O campo `payment_id` contém o ID do pagamento bem-sucedido.

Campos do payload da tentativa de dunning

string

obrigatório

A assinatura que acionou a tentativa de dunning.

string

obrigatório

A marca à qual esta tentativa de dunning pertence.

string

obrigatório

O cliente proprietário da assinatura.

string

obrigatório

O estado da assinatura que acionou a cobrança de inadimplência. Um de:

on_hold — Renovações interrompidas devido a falha no pagamento
cancelled — Cliente cancelado pelo portal do cliente

string

obrigatório

Estado atual do ciclo de vida desta tentativa de dunning. Uma das opções:

recovering — E-mails de dunning estão sendo enviados
recovered — O cliente atualizou o método de pagamento e o pagamento foi bem-sucedido
exhausted — Todos os e-mails enviados ou o estado da assinatura foi alterado

string

obrigatório

Timestamp ISO 8601 de quando a tentativa de dunning foi criada.

string | null

O ID do pagamento de recuperação bem-sucedido. null durante a recuperação.

Exemplo: processando Webhooks de dunning

app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;

  switch (event.type) {
    case 'dunning.started':
      console.log(`Dunning started for subscription: ${event.data.subscription_id}`);
      console.log(`Trigger: ${event.data.trigger_state}`);
      // Track dunning in your system
      await trackDunning(event.data);
      break;

    case 'dunning.recovered':
      console.log(`Subscription recovered: ${event.data.subscription_id}`);
      console.log(`Recovery payment: ${event.data.payment_id}`);
      // Reactivate access, update records
      await handleDunningRecovery(event.data);
      break;
  }

  res.json({ received: true });
});

Inscreva-se em dunning.started e dunning.recovered para acompanhar todo o ciclo de vida do dunning. Use dunning.started para pausar períodos de carência ou sinalizar assinaturas em risco no seu sistema.

Abandoned Cart Recovery

Configure sequências de e-mails ACR e incentivos de desconto.

Subscription Dunning

Configure sequências de e-mails de dunning para assinaturas inadimplentes.

Subscription Webhooks

Eventos relacionados ao ciclo de vida da assinatura, como subscription.on_hold e subscription.cancelled.

Schema do payload do webhook

Webhook payload for abandoned_checkout.detected and abandoned_checkout.recovered events

abandoned_at

string<date-time>

obrigatório

abandonment_reason

enum<string>

obrigatório

Opções disponíveis:

payment_failed,

checkout_incomplete

brand_id

string

obrigatório

Brand id this abandoned checkout belongs to

customer_id

string

obrigatório

payment_id

string

obrigatório

status

enum<string>

obrigatório

Opções disponíveis:

abandoned,

recovering,

recovered,

exhausted,

opted_out

recovered_payment_id

string | null

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Eventos de Recuperação de Carrinho Abandonado

Campos de Payload de Checkout Abandonado

Exemplo: processando Webhooks ACR

Eventos de dunning

Campos do payload da tentativa de dunning

Exemplo: processando Webhooks de dunning

Abandoned Cart Recovery

Subscription Dunning

Subscription Webhooks

Schema do payload do webhook

​Eventos de Recuperação de Carrinho Abandonado

​Campos de Payload de Checkout Abandonado

​Exemplo: processando Webhooks ACR

​Eventos de dunning

​Campos do payload da tentativa de dunning

​Exemplo: processando Webhooks de dunning

Abandoned Cart Recovery

Subscription Dunning

Subscription Webhooks

​Schema do payload do webhook

Eventos de Recuperação de Carrinho Abandonado

Campos de Payload de Checkout Abandonado

Exemplo: processando Webhooks ACR

Eventos de dunning

Campos do payload da tentativa de dunning

Exemplo: processando Webhooks de dunning

Schema do payload do webhook