Customer.io

Introdução

A integração com o Customer.io envia eventos do Dodo Payments para a Track API do Customer.io, permitindo que pagamentos e alterações de assinatura acionem campanhas e jornadas do cliente. Por exemplo, um novo cliente pode receber um e-mail de boas-vindas, uma alteração de assinatura pode enviar uma atualização e um pagamento com falha pode enviar uma notificação.

Esta integração requer o Site ID e a API key do Customer.io. A Track API usa HTTP Basic authentication, com o Site ID como nome de usuário e a API key como senha.

Começando

Open the Webhook Section

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

Caixa de diálogo de adição de endpoint com CustomerIO selecionado no menu suspenso de integração

Select Customer.io

Em Integration, selecione CustomerIO.

Enter Credentials

Em API key, cole sua API key do Customer.io. O Dodo Payments envia a chave no cabeçalho Authorization como um bearer token.A Track API espera Basic authentication. Se as entregas falharem com um 401, abra a aba Advanced do endpoint e substitua o cabeçalho Authorization por Basic seguido da codificação Base64 de site_id:api_key.

Select Events

Em Subscribed events, selecione os eventos tratados pela sua transformação. Os exemplos nesta página usam payment.succeeded, subscription.active e subscription.cancelled.

Configure Transformation

Em Transformation code, edite o handler para formatar eventos para a Track API do Customer.io. Comece pelos exemplos.

Test & Create

Em Test this code, clique em Simulate para executar o handler com um payload de exemplo. Em seguida, clique em Create endpoint.

Done

Os eventos inscritos agora chegam ao Customer.io, onde podem acionar suas automações de e-mail.

Exemplos de código de transformação

Cada handler envia uma solicitação para o endpoint da Track API v2 entity e identifica a pessoa pelo customer_id do Dodo Payments. Para registrar um evento, a solicitação define action como event e coloca o nome do evento em name. Para atualizar os atributos de uma pessoa, ela define action como identify. Os valores do Dodo Payments estão na menor unidade da moeda, portanto os exemplos dividem por 100.

Registrar eventos de pagamento

Registre um evento payment_completed quando um pagamento for aprovado:

track_payments.js

function handler(webhook) {
  if (webhook.eventType === "payment.succeeded") {
    const p = webhook.payload.data;
    webhook.url = "https://track.customer.io/api/v2/entity";
    webhook.payload = {
      type: "person",
      identifiers: {
        id: p.customer.customer_id
      },
      action: "event",
      name: "payment_completed",
      attributes: {
        email: p.customer.email,
        name: p.customer.name,
        payment_amount: (p.total_amount / 100).toFixed(2),
        payment_method: p.payment_method || "unknown",
        payment_id: p.payment_id,
        currency: p.currency || "USD"
      }
    };
  }
  return webhook;
}

Registrar o ciclo de vida da assinatura

Registre um evento subscription_started quando uma assinatura se tornar ativa e um evento subscription_cancelled quando ela for cancelada:

track_subscriptions.js

function handler(webhook) {
  const s = webhook.payload.data;
  switch (webhook.eventType) {
    case "subscription.active":
      webhook.url = "https://track.customer.io/api/v2/entity";
      webhook.payload = {
        type: "person",
        identifiers: {
          id: s.customer.customer_id
        },
        action: "event",
        name: "subscription_started",
        attributes: {
          email: s.customer.email,
          subscription_id: s.subscription_id,
          product_id: s.product_id,
          amount: (s.recurring_pre_tax_amount / 100).toFixed(2),
          frequency: s.payment_frequency_interval,
          next_billing: s.next_billing_date
        }
      };
      break;
    case "subscription.cancelled":
      webhook.url = "https://track.customer.io/api/v2/entity";
      webhook.payload = {
        type: "person",
        identifiers: {
          id: s.customer.customer_id
        },
        action: "event",
        name: "subscription_cancelled",
        attributes: {
          email: s.customer.email,
          subscription_id: s.subscription_id,
          cancelled_at: s.cancelled_at,
          cancel_at_next_billing: s.cancel_at_next_billing_date
        }
      };
      break;
  }
  return webhook;
}

Registrar atributos do cliente

Atualize os atributos do perfil da pessoa quando um pagamento for aprovado. Cada solicitação identify substitui os atributos enviados, portanto last_payment_amount e last_payment_date sempre contêm o pagamento mais recente.

track_attributes.js

function handler(webhook) {
  if (webhook.eventType === "payment.succeeded") {
    const p = webhook.payload.data;
    webhook.url = "https://track.customer.io/api/v2/entity";
    webhook.payload = {
      type: "person",
      identifiers: {
        id: p.customer.customer_id
      },
      action: "identify",
      name: "Customer Identified",
      attributes: {
        email: p.customer.email,
        name: p.customer.name,
        last_payment_amount: (p.total_amount / 100).toFixed(2),
        payment_method: p.payment_method || "unknown",
        last_payment_date: webhook.payload.timestamp
      }
    };
  }
  return webhook;
}

Dicas

Use os mesmos nomes de eventos na transformação e nos gatilhos das campanhas do Customer.io, por exemplo, payment_completed. Escolha nomes que descrevam o que aconteceu.
Inclua os atributos usados pelas suas mensagens para personalização.
Identifique cada pessoa pelo mesmo ID em todas as solicitações. Os exemplos usam o customer_id do Dodo Payments.
Para ver todos os campos da solicitação, consulte a referência da Track API do Customer.io.

Solução de problemas

Events Not Triggering Campaigns

Verifique se o Site ID e a API key estão corretos.
Se as entregas falharem com um 401, defina o cabeçalho Authorization como Basic authentication, conforme descrito em Primeiros passos.
Verifique se os nomes dos eventos correspondem aos gatilhos das suas campanhas do Customer.io.
Verifique se os identificadores dos clientes estão definidos.
Consulte os rate limits da API do Customer.io.

Transformation Errors

Verifique se o payload corresponde ao formato da API do Customer.io.
Verifique se todos os campos obrigatórios estão presentes e se action é uma ação compatível com a Track API, como event ou identify.
Verifique se os nomes dos eventos e os atributos estão formatados corretamente.

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

Introdução

Começando

Exemplos de código de transformação

Registrar eventos de pagamento

Registrar o ciclo de vida da assinatura

Registrar atributos do cliente

Dicas

Solução de problemas

​Introdução

​Começando

​Exemplos de código de transformação

​Registrar eventos de pagamento

​Registrar o ciclo de vida da assinatura

​Registrar atributos do cliente

​Dicas

​Solução de problemas

Introdução

Começando

Exemplos de código de transformação

Registrar eventos de pagamento

Registrar o ciclo de vida da assinatura

Registrar atributos do cliente

Dicas

Solução de problemas