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と変換コードが入力されます。

IntegrationドロップダウンでKeplarsが選択されたエンドポイント追加ダイアログ

Enter API Key

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

Keplars endpoint URL、API keyフィールド、Subscribed eventsリストが入力された状態

Configure Transformation

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

Test & Create

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

Done

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

変換コード例

各ハンドラーはwebhook.urlをKeplarsの高優先度送信エンドポイントに設定し、webhook.payloadをKeplarsリクエストに書き換えます。Dodo PaymentsはAPI keyをBearer tokenとして追加します。your-keplars-*-template-idを自分のテンプレートIDに置き換えます。Keplars send APIにはfromフィールドがないため、KeplarsはKeplars dashboardで設定した送信者から各メールを送信します。

toは、受信者が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],
    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],
    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],
    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],
    template_id: "your-keplars-subscription-cancelled-template-id",
    params: {
      customer_name: data.customer?.name,
      subscription_id: data.subscription_id,
      cancellation_date: cancellationDate,
    },
  };
  return webhook;
}

ヒント

配信性を高めるため、認証済みのドメインまたはアドレスから送信します。
各メールのブランドとメッセージを一貫させるため、イベントタイプごとにKeplarsテンプレートを1つ作成します。
paramsに名前、金額、支払いIDなどの顧客データを渡して、各メールをパーソナライズします。
まずsandboxモードでテストします。Keplarsでは、sandboxでの送信は配信されず、Test Inboxに記録されます。

トラブルシューティング

Emails not being sent

KeplarsのSettings → API Keysで、API keyが正しく、有効になっていることを確認します。
送信者のドメインまたはアドレスが認証済みであることを確認します。
Dodo Payments dashboardで、Developer → WebhooksのLogsタブからメッセージを開きます。各配信試行には、Keplarsからの生のエラーレスポンスが表示されます。

Template not found

ハンドラー内のtemplate_idが、Keplarsアカウントで有効なテンプレートと一致している必要があります。Keplars dashboardでIDを確認し、テンプレートが有効になっていることを確認します。

Wrong event triggered

各ハンドラーはwebhook.eventTypeを確認し、イベントが一致しない場合はwebhookを変更せずに返します。エンドポイントのSubscribed eventsに、必要なイベントだけが含まれていることを確認します。

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

はじめに

はじめに

変換コード例

支払い確認メール

支払い失敗通知

サブスクリプションウェルカムメール

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

ヒント

トラブルシューティング

​はじめに

​はじめに

​変換コード例

​支払い確認メール

​支払い失敗通知

​サブスクリプションウェルカムメール

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

​ヒント

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

はじめに

はじめに

変換コード例

支払い確認メール

支払い失敗通知

サブスクリプションウェルカムメール

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

ヒント

トラブルシューティング