Keplars

はじめに

支払いおよびサブスクリプションイベントが発生した際に、トランザクションメールを自動送信します。支払い確認、サブスクリプションの更新、失敗通知を、ミドルウェアサーバーなしでKeplars経由で送信できます。Dodo PaymentsがJavaScript transformation handlerを使用してKeplars APIを直接呼び出します。

このintegrationではKeplars API keyで認証します。Keplars dashboardのSettings → API KeysでAPI keyを確認し、Domainsでsender domainまたはaddressを検証してください。

はじめに

Open the Webhook Section

Dodo Payments dashboardでDeveloper → Webhooksに移動し、Add endpointをクリックします。

Select Keplars

IntegrationでKeplarsを選択します。テンプレートによってKeplars API URLとtransformation codeが入力されます。

Enter API Key

Keplars API keyをAPI keyに貼り付けます。Dodo PaymentsはすべてのrequestでBearer tokenとして送信します。Subscribed eventsで、メールを送信するイベントを選択します。

Configure Transformation

Transformation codeで、Keplars向けにメールをフォーマットするコードを編集します。プレースホルダーのsender addressとtemplate IDsを自分のものに置き換えます。

Test & Create

Test this codeでevent typeを選択し、Simulateをクリックして、sample payloadに対してtransformationを実行します。次にCreate endpointをクリックして、メールの送信を開始します。

Done

Dodo Paymentsのイベントによって、Keplars経由でトランザクションメールが送信されるようになりました。

変換コード例

各handlerはwebhook.urlをKeplarsのhigh-priority send endpointに設定し、webhook.payloadをKeplars requestに書き換えます。Dodo PaymentsはAPI keyをBearer tokenとして追加します。payments@mail.yourdomain.comを検証済みのsenderに置き換え、your-keplars-*-template-idをtemplate IDsに置き換えてください。

toは、recipientが1人だけの場合でもarrayでなければなりません。template_idを使用する場合は、テンプレートから提供されるため、subjectまたはbodyも送信しないでください。

支払い確認メール

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],
    from: "payments@mail.yourdomain.com",
    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;
}

支払い失敗通知

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],
    from: "payments@mail.yourdomain.com",
    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;
}

サブスクリプション開始メール

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],
    from: "payments@mail.yourdomain.com",
    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;
}

サブスクリプションキャンセルメール

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],
    from: "payments@mail.yourdomain.com",
    template_id: "your-keplars-subscription-cancelled-template-id",
    params: {
      customer_name: data.customer?.name,
      subscription_id: data.subscription_id,
      cancellation_date: cancellationDate,
    },
  };
  return webhook;
}

ヒント

配信到達率を高めるため、検証済みのdomainまたはaddressから送信します。
各メールのブランドとメッセージを統一できるよう、event typeごとにKeplars templateを1つ作成します。
paramsにname、amount、payment IDなどのcustomer dataを渡して、各メールをパーソナライズします。
まずsandbox modeでテストします。Keplarsはsandbox送信を配信せず、Test Inboxに取り込みます。

トラブルシューティング

Emails not being sent

KeplarsのSettings → API Keysで、API keyが正しく、有効になっていることを確認します。
sender domainまたはaddressが検証済みであることを確認します。
Dodo Payments dashboardで、Developer → WebhooksのLogsタブからmessageを開きます。各delivery attemptに、Keplarsからのraw error responseが表示されます。

Template not found

handler内のtemplate_idは、Keplars accountで有効なtemplateと一致している必要があります。Keplars dashboardでIDとtemplateが有効であることを確認します。

Wrong event triggered

各handlerはwebhook.eventTypeを確認し、eventが一致しない場合はwebhookを変更せずに返します。endpointのSubscribed eventsに、必要なイベントのみが含まれていることを確認します。

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

はじめに

はじめに

変換コード例

支払い確認メール

支払い失敗通知

サブスクリプション開始メール

サブスクリプションキャンセルメール

ヒント

トラブルシューティング

​はじめに

​はじめに

​変換コード例

​支払い確認メール

​支払い失敗通知

​サブスクリプション開始メール

​サブスクリプションキャンセルメール

​ヒント

​トラブルシューティング

はじめに

はじめに

変換コード例

支払い確認メール

支払い失敗通知

サブスクリプション開始メール

サブスクリプションキャンセルメール

ヒント

トラブルシューティング