SendGrid

はじめに

SendGrid integrationは、Dodo Paymentsのイベント発生時に、SendGridのMail Send APIを通じてトランザクションメールを送信します。各メールにはSendGridのダイナミックテンプレートの1つが使用され、イベントのデータがテンプレートに入力されます。これにより、決済の確認、新規サブスクライバーへのウェルカムメール、決済失敗後のフォローアップを行えます。

このintegrationには、Mail Send permissionを持つSendGrid API key、SendGridでverified senderに設定された送信者、送信する各メール用のダイナミックテンプレートが必要です。また、Dodo Payments dashboardのDeveloper → Webhooksにアクセスできる必要があります。

始め方

Open the Webhook Section

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

Add endpoint dialog with SendGrid selected in the Integration dropdown and the How to connect SendGrid steps

Select SendGrid

IntegrationでSendGridを選択します。dashboardにEndpoint URLとSendGrid用のtransformation codeが入力され、How to connect SendGridパネルにセットアップ手順が表示されます。

Enter API Key

SendGridでSettings → API Keysに移動し、Create API Keyをクリックします。Restricted AccessとMail Send permission、またはFull Accessを選択します。SendGridが表示するkeyは、SG.で始まり、一度しか表示されません。これをAPI keyに貼り付けます。Dodo Paymentsは、SendGridへのすべてのrequestでAuthorization headerのbearer tokenとしてこのkeyを送信します。

Select Events

Subscribed eventsで、transformationが処理するeventのみを選択します。transformationが変更せずに通過させたeventはDodo Payments形式のままSendGridに到達し、SendGridによって拒否されます。

Configure Transformation

Transformation codeでhandlerを編集し、SendGridのMail Send API用にメールをフォーマットします。examplesを参考に、各template_idを独自のダイナミックテンプレートのIDに置き換えます。このIDはd-で始まります。

Test & Create

Test this codeでevent typeを選択し、SimulateをクリックしてSendGridへのrequestをプレビューします。次にCreate endpointをクリックします。

Done

これでDodo Paymentsは、サブスクライブした各eventについてSendGrid経由でメールを送信します。各deliveryとSendGridのresponseを確認するには、Developer → WebhooksのLogs tabを開きます。

Transformation Codeの例

各handlerはwebhook.urlをMail Send endpointに設定し、dynamic_template_dataを通じてevent dataをダイナミックテンプレートに渡します。Dodo Paymentsの金額は最小通貨単位で表されるため、例では100で割っています。JPYやKRWなどの小数点以下の桁がない通貨では、金額をそのまま使用してください。

決済確認メール

決済が成功したときにreceiptを送信します（payment.succeeded）：

payment_confirmation.js

function handler(webhook) {
  if (webhook.eventType === "payment.succeeded") {
    const p = webhook.payload.data;
    webhook.url = "https://api.sendgrid.com/v3/mail/send";
    webhook.payload = {
      personalizations: [
        {
          to: [{ email: p.customer.email }],
          dynamic_template_data: {
            customer_name: p.customer.name,
            payment_amount: (p.total_amount / 100).toFixed(2),
            payment_id: p.payment_id,
            payment_date: new Date(webhook.payload.timestamp).toLocaleDateString(),
            currency: p.currency || "USD"
          }
        }
      ],
      from: {
        email: "payments@yourdomain.com",
        name: "Your Company"
      },
      template_id: "d-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    };
  }
  return webhook;
}

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

サブスクリプションがactiveになったときにcustomerを歓迎します（subscription.active）：

subscription_welcome.js

function handler(webhook) {
  if (webhook.eventType === "subscription.active") {
    const s = webhook.payload.data;
    webhook.url = "https://api.sendgrid.com/v3/mail/send";
    webhook.payload = {
      personalizations: [
        {
          to: [{ email: s.customer.email }],
          dynamic_template_data: {
            customer_name: s.customer.name,
            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: new Date(s.next_billing_date).toLocaleDateString()
          }
        }
      ],
      from: {
        email: "welcome@yourdomain.com",
        name: "Your Company"
      },
      template_id: "d-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    };
  }
  return webhook;
}

決済失敗通知

決済が失敗したときにcustomerへ再試行を促します（payment.failed）：

payment_failure.js

function handler(webhook) {
  if (webhook.eventType === "payment.failed") {
    const p = webhook.payload.data;
    webhook.url = "https://api.sendgrid.com/v3/mail/send";
    webhook.payload = {
      personalizations: [
        {
          to: [{ email: p.customer.email }],
          dynamic_template_data: {
            customer_name: p.customer.name,
            payment_amount: (p.total_amount / 100).toFixed(2),
            error_message: p.error_message || "Payment processing failed",
            payment_id: p.payment_id,
            retry_link: `https://yourdomain.com/retry-payment/${p.payment_id}`
          }
        }
      ],
      from: {
        email: "support@yourdomain.com",
        name: "Your Company Support"
      },
      template_id: "d-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    };
  }
  return webhook;
}

ヒント

SendGridのダイナミックテンプレートを使用してコンテンツをパーソナライズします。
テンプレートに必要な決済データをdynamic_template_dataに渡します。
verified senderに一致するfrom addressと、sender nameを設定します。
template IDを再利用して、同じ種類のメールで同じ形式を維持します。
marketing contentを含むメールにはunsubscribe linkを含めます。
codeでeventをスキップするには、webhookをreturnする前にwebhook.cancel = trueを設定します。logsでは、スキップされたdeliveryも成功として記録されます。

トラブルシューティング

Emails Not Being Sent

API keyにMail Send permissionがあることを確認します。置き換えるには、endpointを編集し、API keyに新しいkeyを貼り付けます。
各template_idがactiveなダイナミックテンプレートに属していることを確認します。
recipientのemail addressが有効であることを確認します。
ご利用のplanにおけるSendGridのsending limitsとquotasを確認します。
Developer → WebhooksのLogs tabを開き、failed deliveryに対するSendGridのresponseを確認します。

Transformation Errors

payloadがSendGridのMail Send formatと一致していることを確認します。
必須fieldがすべて存在することを確認します。personalizationsには少なくとも1つのto addressが必要で、fromも必要です。
dynamic_template_dataのkeyが、{{customer_name}}など、template内のvariableと一致していることを確認します。
各from addressがSendGridでverifiedになっていることを確認します。

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

はじめに

始め方

Transformation Codeの例

決済確認メール

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

決済失敗通知

ヒント

トラブルシューティング

​はじめに

​始め方

​Transformation Codeの例

​決済確認メール

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

​決済失敗通知

​ヒント

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

はじめに

始め方

Transformation Codeの例

決済確認メール

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

決済失敗通知

ヒント

トラブルシューティング