Keplars

Introdução

Envie emails transacionais automaticamente quando ocorrerem eventos de pagamento e assinatura. Confirmações de pagamento, atualizações de assinatura e notificações de falha são enviadas pelo Keplars sem um servidor de middleware: o Dodo Payments chama a API do Keplars diretamente, usando um handler de transformação em JavaScript.

Essa integração autentica usando sua chave de API do Keplars. Encontre-a no dashboard do Keplars em Settings → API Keys e verifique um domínio ou endereço de remetente em Domains.

Começando

Open the Webhook Section

No dashboard do Dodo Payments, acesse Developer → Webhooks e clique em Add endpoint.

Select Keplars

Em Integração, selecione Keplars. O template preenche a URL da API do Keplars e o código de transformação.

Caixa de diálogo de adição de endpoint com Keplars selecionado no menu suspenso Integração

Enter API Key

Cole sua chave de API do Keplars em Chave de API. O Dodo Payments a envia como um token Bearer em todas as solicitações. Em Eventos inscritos, selecione os eventos que devem enviar um e-mail.

URL do endpoint do Keplars preenchida, campo de chave de API e lista de Eventos inscritos

Configure Transformation

Em Código de transformação, edite o código para formatar e-mails para o Keplars. Substitua os IDs de template de exemplo pelos seus.

Test & Create

Em Test this code, selecione um tipo de evento e clique em Simulate para executar a transformação com um payload de exemplo. Em seguida, clique em Create endpoint para começar a enviar emails.

Done

Os eventos do Dodo Payments agora enviam emails transacionais pelo Keplars.

Exemplos de Código de Transformação

Cada handler define webhook.url como o endpoint de envio de alta prioridade do Keplars e reescreve webhook.payload em uma solicitação ao Keplars. O Dodo Payments adiciona a chave de API como um token Bearer. Substitua your-keplars-*-template-id pelos IDs dos seus templates. A API de envio do Keplars não tem um campo from, portanto o Keplars envia cada e-mail a partir de um remetente configurado no painel do Keplars.

to deve ser um array, mesmo para um único destinatário. Ao usar template_id, não envie também subject ou body, pois o template os fornece.

E-mail de confirmação de pagamento

payment_succeeded.js

function handler(webhook) {
  if (webhook.eventType !== "payment.succeeded") return webhook;

  const data = webhook.payload.data || {};
  const paymentDate = new Date(webhook.payload.timestamp).toLocaleDateString("en-US", {
    year: "numeric", month: "long", day: "numeric",
  });

  webhook.url = "https://api.keplars.com/api/v1/send-email/high";
  webhook.payload = {
    to: [data.customer?.email],
    template_id: "your-keplars-payment-success-template-id",
    params: {
      customer_name: data.customer?.name,
      amount: ((data.total_amount || 0) / 100).toFixed(2),
      currency: data.currency || "USD",
      payment_id: data.payment_id,
      payment_method: data.payment_method,
      payment_date: paymentDate,
    },
  };
  return webhook;
}

Notificação de falha no pagamento

payment_failed.js

function handler(webhook) {
  if (webhook.eventType !== "payment.failed") return webhook;

  const data = webhook.payload.data || {};
  const paymentDate = new Date(webhook.payload.timestamp).toLocaleDateString("en-US", {
    year: "numeric", month: "long", day: "numeric",
  });

  webhook.url = "https://api.keplars.com/api/v1/send-email/high";
  webhook.payload = {
    to: [data.customer?.email],
    template_id: "your-keplars-payment-failed-template-id",
    params: {
      customer_name: data.customer?.name,
      amount: ((data.total_amount || 0) / 100).toFixed(2),
      currency: data.currency || "USD",
      payment_id: data.payment_id,
      error_message: data.error_message || "Your payment could not be processed.",
      payment_date: paymentDate,
    },
  };
  return webhook;
}

E-mail de boas-vindas à assinatura

subscription_active.js

function handler(webhook) {
  if (webhook.eventType !== "subscription.active") return webhook;

  const data = webhook.payload.data || {};
  const nextBilling = data.next_billing_date
    ? new Date(data.next_billing_date).toLocaleDateString("en-US", {
        year: "numeric", month: "long", day: "numeric",
      })
    : "";

  webhook.url = "https://api.keplars.com/api/v1/send-email/high";
  webhook.payload = {
    to: [data.customer?.email],
    template_id: "your-keplars-subscription-active-template-id",
    params: {
      customer_name: data.customer?.name,
      subscription_id: data.subscription_id,
      product_id: data.product_id,
      amount: ((data.recurring_pre_tax_amount || 0) / 100).toFixed(2),
      currency: data.currency || "USD",
      billing_interval: data.payment_frequency_interval || "Month",
      next_billing_date: nextBilling,
    },
  };
  return webhook;
}

E-mail de cancelamento da assinatura

subscription_cancelled.js

function handler(webhook) {
  if (webhook.eventType !== "subscription.cancelled") return webhook;

  const data = webhook.payload.data || {};
  const cancellationDate = new Date(webhook.payload.timestamp).toLocaleDateString("en-US", {
    year: "numeric", month: "long", day: "numeric",
  });

  webhook.url = "https://api.keplars.com/api/v1/send-email/high";
  webhook.payload = {
    to: [data.customer?.email],
    template_id: "your-keplars-subscription-cancelled-template-id",
    params: {
      customer_name: data.customer?.name,
      subscription_id: data.subscription_id,
      cancellation_date: cancellationDate,
    },
  };
  return webhook;
}

Dicas

Envie de um domínio ou endereço verificado para melhorar a entregabilidade.
Crie um template do Keplars para cada tipo de evento, para que cada e-mail mantenha a identidade e a mensagem da sua marca.
Personalize cada e-mail passando dados do cliente, como nome, valor e ID do pagamento, em params.
Teste primeiro no modo sandbox. O Keplars captura os envios do sandbox na Caixa de entrada de testes em vez de entregá-los.

Solução de problemas

Emails not being sent

Verifique se sua chave de API está correta e ativa no Keplars, em Configurações → Chaves de API.
Verifique se o domínio ou endereço do remetente está verificado.
No painel do Dodo Payments, abra a mensagem na aba Logs de Desenvolvedor → Webhooks. Cada tentativa de entrega mostra a resposta de erro bruta do Keplars.

Template not found

O template_id no seu handler deve corresponder a um template ativo na sua conta do Keplars. Verifique o ID e confirme se o template está ativo no painel do Keplars.

Wrong event triggered

Cada handler verifica webhook.eventType e retorna o webhook inalterado se o evento não corresponder. Verifique se os Eventos inscritos do endpoint incluem apenas os eventos desejados.

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

Introdução

Começando

Exemplos de Código de Transformação

E-mail de confirmação de pagamento

Notificação de falha no pagamento

E-mail de boas-vindas à assinatura

E-mail de cancelamento da assinatura

Dicas

Solução de problemas

​Introdução

​Começando

​Exemplos de Código de Transformação

​E-mail de confirmação de pagamento

​Notificação de falha no pagamento

​E-mail de boas-vindas à assinatura

​E-mail de cancelamento da assinatura

​Dicas

​Solução de problemas

Introdução

Começando

Exemplos de Código de Transformação

E-mail de confirmação de pagamento

Notificação de falha no pagamento

E-mail de boas-vindas à assinatura

E-mail de cancelamento da assinatura

Dicas

Solução de problemas