Customer.io

はじめに

Customer.io integrationは、Dodo PaymentsのイベントをCustomer.ioのTrack APIに送信するため、支払いとサブスクリプションの変更をキャンペーンやカスタマージャーニーのトリガーにできます。たとえば、新しい顧客にウェルカムメールを送信したり、サブスクリプションの変更時に更新通知を送信したり、支払いが失敗したときに通知を送信したりできます。

このintegrationにはCustomer.io Site IDとAPI keyが必要です。Track APIではHTTP Basic authenticationを使用し、ユーザー名にSite ID、パスワードにAPI keyを指定します。

始め方

Open the Webhook Section

Dodo Payments ダッシュボードで、Developer → Webhooks に移動し、Add endpoint をクリックします。

Add endpoint dialog with CustomerIO selected in the Integration dropdown

Select Customer.io

Integrationで、CustomerIOを選択します。

Enter Credentials

API keyに、Customer.io API keyを貼り付けます。Dodo Paymentsは、bearer tokenとしてAuthorization headerにkeyを送信します。Track APIではBasic authenticationが必要です。401で配信が失敗した場合は、endpointのAdvancedタブを開き、Authorization headerを、site_id:api_keyのBase64 encodingを後に続けたBasicに置き換えます。

Select Events

Subscribed eventsで、transformationが処理するイベントを選択します。このページの例では、payment.succeeded、subscription.active、subscription.cancelledを使用します。

Configure Transformation

Transformation codeで、Customer.ioのTrack API用にイベントをフォーマットするhandlerを編集します。examplesから始めることができます。

Test & Create

Test this codeでSimulateをクリックし、サンプルpayloadに対してhandlerを実行します。次にCreate endpointをクリックします。

Done

これでSubscribed eventsがCustomer.ioに届き、メールautomationをトリガーできるようになります。

Transformation Code Examples

各handlerはTrack API v2のentity endpointに1件のrequestを送信し、Dodo Paymentsのcustomer_idでpersonを識別します。イベントを記録するには、requestのactionにeventを設定し、イベント名をnameに指定します。personの属性を更新するには、actionにidentifyを設定します。Dodo Paymentsの金額は最小通貨単位で指定されるため、例では100で割っています。

Track Payment Events

支払いが成功したときにpayment_completedイベントを記録します:

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;
}

Track Subscription Lifecycle

サブスクリプションがactiveになったときにsubscription_startedイベントを、キャンセルされたときにsubscription_cancelledイベントを記録します:

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;
}

Track Customer Attributes

支払いが成功したときにpersonのprofile属性を更新します。各identify requestは送信した属性を上書きするため、last_payment_amountとlast_payment_dateには常に最新の支払い情報が保持されます。

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;
}

Tips

transformationとCustomer.io campaign triggersで同じイベント名を使用します。たとえばpayment_completedです。発生した内容を表す名前を選択してください。
メッセージのパーソナライズに使用する属性を含めます。
すべてのrequestで、同じIDを使って各personを識別します。例ではDodo Paymentsのcustomer_idを使用しています。
各request fieldについては、Customer.io Track API referenceを参照してください。

Troubleshooting

Events Not Triggering Campaigns

Site IDとAPI keyが正しいことを確認します。
401で配信が失敗した場合は、Getting Startedの説明に従い、Authorization headerをBasic authenticationに設定します。
イベント名がCustomer.io campaign triggersと一致していることを確認します。
customer identifiersが設定されていることを確認します。
Customer.io APIのrate limitsを確認します。

Transformation Errors

payloadがCustomer.io API formatと一致していることを確認します。
必須fieldがすべて存在し、actionがeventやidentifyなど、Track APIがサポートするactionであることを確認します。
イベント名と属性が正しくフォーマットされていることを確認します。

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

はじめに

始め方

Transformation Code Examples

Track Payment Events

Track Subscription Lifecycle

Track Customer Attributes

Tips

Troubleshooting

​はじめに

​始め方

​Transformation Code Examples

​Track Payment Events

​Track Subscription Lifecycle

​Track Customer Attributes

​Tips

​Troubleshooting

はじめに

始め方

Transformation Code Examples

Track Payment Events

Track Subscription Lifecycle

Track Customer Attributes

Tips

Troubleshooting