Slack

Giới thiệu

Tích hợp Slack đăng các sự kiện Dodo Payments, chẳng hạn như thanh toán thành công, thay đổi gói đăng ký và tranh chấp, lên kênh Slack bạn chọn. Nhóm của bạn có thể theo dõi các khoản thanh toán và xử lý tranh chấp từ Slack mà không cần kiểm tra dashboard.

Slack connector chuyển mỗi sự kiện Dodo Payments thành một tin nhắn Slack thông qua transformation: đoạn mã JavaScript chạy trên sự kiện trước khi gửi. Connector đi kèm mã transformation, vì vậy bạn không cần viết mã để bắt đầu. Bạn cần có quyền truy cập Developer → Webhooks trong dashboard Dodo Payments và quyền thêm ứng dụng vào workspace Slack của mình.

Bắt đầu

Open the Webhook Section

Trong dashboard Dodo Payments, đi đến Developer → Webhooks và nhấp vào Add endpoint.

Add endpoint dialog with the Integration dropdown set to Custom webhook

Select Slack Integration

Trong Integration, chọn Slack. Dashboard tải mã chuyển đổi Slack và hiển thị các bước thiết lập trong panel How to connect Slack.

Add endpoint dialog with Slack selected and the How to connect Slack steps

Create a Slack Webhook URL

Trong Slack, tạo một ứng dụng có incoming webhook cho kênh sẽ nhận thông báo:

Mở api.slack.com/apps, nhấp vào Create New App và chọn From scratch.
Đặt tên cho ứng dụng, chẳng hạn Dodo Payments Notifications, chọn workspace của bạn và nhấp vào Create App.
Trong thanh bên, mở Incoming Webhooks và bật Activate Incoming Webhooks.
Nhấp vào Add New Webhook to Workspace, chọn kênh và nhấp vào Allow.
Sao chép Webhook URL, bắt đầu bằng https://hooks.slack.com/services/.

Màn hình cấp quyền Slack với bộ chọn kênh và nút Allow

Paste the Webhook URL

Dán Slack webhook URL vào Endpoint URL. Slack không cần API key.

Select Events

Subscribed events liệt kê các sự kiện mà Slack connector hỗ trợ. Nếu bạn thay đổi transformation, chỉ giữ lại các sự kiện mà transformation đó xử lý. Slack từ chối request không phải là tin nhắn Slack, vì vậy một sự kiện mà transformation giữ nguyên sẽ không gửi được.

Customize Transformation Code

Trong Transformation code, chỉnh sửa handler để chọn những sự kiện đăng tin nhắn và cách hiển thị từng tin nhắn. Giữ nguyên mã của connector hoặc bắt đầu từ các ví dụ.

Trình chỉnh sửa mã transformation với Slack handler cho các sự kiện thanh toán

Test and Create

Trong Test this code, chọn một loại event và nhấp vào Simulate. Result hiển thị message mà Slack sẽ nhận. Sau đó nhấp vào Create endpoint.

Test this code panel with payment.succeeded selected, a Simulate button, and the Create endpoint button

Integration Complete!

Dodo Payments hiện đăng mỗi sự kiện đã đăng ký lên kênh Slack của bạn. Để đăng một tin nhắn kiểm thử, mở tab Testing của endpoint, chọn loại sự kiện và nhấp vào Send example.

Ví dụ về mã chuyển đổi

Mỗi handler thay thế webhook.payload bằng một message Slack và giữ nguyên webhook.url, URL webhook đến của bạn. Số tiền trong Dodo Payments được biểu thị theo đơn vị tiền tệ nhỏ nhất, vì vậy các ví dụ chia cho 100 và hiển thị mã tiền tệ. Đối với các loại tiền tệ không có chữ số thập phân như JPY và KRW, hãy sử dụng nguyên giá trị amount.

Thông báo thanh toán cơ bản

Đăng một message dạng văn bản thuần túy khi thanh toán thành công, thất bại hoặc đang được xử lý:

payment_notifs.js

function handler(webhook) {
  switch (webhook.eventType) {
    case "payment.succeeded":
      webhook.payload = {
        text: `✅ Payment Successful\nAmount: ${(webhook.payload.data.total_amount / 100).toFixed(2)} ${webhook.payload.data.currency}\nCustomer: ${webhook.payload.data.customer.email}\nPayment ID: ${webhook.payload.data.payment_id}`
      };
      break;
      
    case "payment.failed":
      webhook.payload = {
        text: `❌ Payment Failed\nAmount: ${(webhook.payload.data.total_amount / 100).toFixed(2)} ${webhook.payload.data.currency}\nCustomer: ${webhook.payload.data.customer.email}\nReason: ${webhook.payload.data.error_message || 'Unknown'}`
      };
      break;
      
    case "payment.processing":
      webhook.payload = {
        text: `⏳ Payment Processing\nAmount: ${(webhook.payload.data.total_amount / 100).toFixed(2)} ${webhook.payload.data.currency}\nCustomer: ${webhook.payload.data.customer.email}`
      };
      break;
  }

  return webhook;
}

Thông báo subscription đa dạng

Đăng một message được mã hóa màu kèm các trường attachment khi một subscription được kích hoạt, bị hủy hoặc gia hạn:

subscription_notifs.js

function handler(webhook) {
  switch (webhook.eventType) {
    case "subscription.active":
      webhook.payload = {
        attachments: [{
          color: "good",
          title: "🎉 Subscription Activated",
          fields: [
            {
              title: "Customer",
              value: webhook.payload.data.customer.email,
              short: true
            },
            {
              title: "Product ID",
              value: webhook.payload.data.product_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.recurring_pre_tax_amount / 100).toFixed(2)} ${webhook.payload.data.currency}/${webhook.payload.data.payment_frequency_interval}`,
              short: true
            },
            {
              title: "Next Billing",
              value: new Date(webhook.payload.data.next_billing_date).toLocaleDateString(),
              short: true
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "subscription.cancelled":
      webhook.payload = {
        attachments: [{
          color: "warning",
          title: "⚠️ Subscription Cancelled",
          fields: [
            {
              title: "Customer",
              value: webhook.payload.data.customer.email,
              short: true
            },
            {
              title: "Product ID",
              value: webhook.payload.data.product_id,
              short: true
            },
            {
              title: "Cancellation Date",
              value: new Date(webhook.payload.data.cancelled_at).toLocaleDateString(),
              short: true
            },
            {
              title: "Cancel at Next Billing",
              value: webhook.payload.data.cancel_at_next_billing_date ? "Yes" : "No",
              short: true
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "subscription.renewed":
      webhook.payload = {
        attachments: [{
          color: "good",
          title: "🔄 Subscription Renewed",
          fields: [
            {
              title: "Customer",
              value: webhook.payload.data.customer.email,
              short: true
            },
            {
              title: "Product ID",
              value: webhook.payload.data.product_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.recurring_pre_tax_amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Next Billing",
              value: new Date(webhook.payload.data.next_billing_date).toLocaleDateString(),
              short: true
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
  }

  return webhook;
}

Thông báo quản lý dispute

Đăng message màu đỏ khi một dispute được mở hoặc bị thua, và message màu xanh lá khi dispute được thắng:

dispute_notifs.js

function handler(webhook) {
  switch (webhook.eventType) {
    case "dispute.opened":
      webhook.payload = {
        attachments: [{
          color: "danger",
          title: "🚨 New Dispute Opened",
          fields: [
            {
              title: "Payment ID",
              value: webhook.payload.data.payment_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Status",
              value: webhook.payload.data.dispute_status,
              short: true
            },
            {
              title: "Stage",
              value: webhook.payload.data.dispute_stage,
              short: true
            },
            {
              title: "Remarks",
              value: webhook.payload.data.remarks || "No remarks",
              short: false
            }
          ],
          footer: "Dodo Payments - Action Required",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "dispute.won":
      webhook.payload = {
        attachments: [{
          color: "good",
          title: "✅ Dispute Won",
          fields: [
            {
              title: "Payment ID",
              value: webhook.payload.data.payment_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Status",
              value: webhook.payload.data.dispute_status,
              short: true
            },
            {
              title: "Resolution",
              value: "Dispute resolved in your favor",
              short: false
            }
          ],
          footer: "Dodo Payments",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
      
    case "dispute.lost":
      webhook.payload = {
        attachments: [{
          color: "danger",
          title: "❌ Dispute Lost",
          fields: [
            {
              title: "Payment ID",
              value: webhook.payload.data.payment_id,
              short: true
            },
            {
              title: "Amount",
              value: `${(webhook.payload.data.amount / 100).toFixed(2)} ${webhook.payload.data.currency}`,
              short: true
            },
            {
              title: "Status",
              value: webhook.payload.data.dispute_status,
              short: true
            },
            {
              title: "Impact",
              value: "The disputed amount stays deducted from your balance",
              short: false
            }
          ],
          footer: "Dodo Payments - Review Required",
          ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
        }]
      };
      break;
  }

  return webhook;
}

Handler cho tất cả event

Đăng message theo cùng một định dạng cho mọi loại event. Các event không có case riêng sẽ nhận message chung với loại event và thời gian:

all_events_notifs.js

function handler(webhook) {
  const event = webhook.payload.data;
  const timestamp = new Date(webhook.payload.timestamp).toLocaleString();
  
  let color, emoji, title, fields = [];
  
  switch (webhook.eventType) {
    case "payment.succeeded":
      color = "good";
      emoji = "✅";
      title = "Payment Successful";
      fields = [
        { title: "Amount", value: `${(event.total_amount / 100).toFixed(2)} ${event.currency}`, short: true },
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Payment ID", value: event.payment_id, short: true },
        { title: "Method", value: event.payment_method || "Unknown", short: true }
      ];
      break;
      
    case "payment.failed":
      color = "danger";
      emoji = "❌";
      title = "Payment Failed";
      fields = [
        { title: "Amount", value: `${(event.total_amount / 100).toFixed(2)} ${event.currency}`, short: true },
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Reason", value: event.error_message || "Unknown", short: false }
      ];
      break;
      
    case "subscription.active":
      color = "good";
      emoji = "🎉";
      title = "Subscription Activated";
      fields = [
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Product ID", value: event.product_id, short: true },
        { title: "Amount", value: `${(event.recurring_pre_tax_amount / 100).toFixed(2)} ${event.currency}/${event.payment_frequency_interval}`, short: true },
        { title: "Next Billing", value: new Date(event.next_billing_date).toLocaleDateString(), short: true }
      ];
      break;
      
    case "subscription.cancelled":
      color = "warning";
      emoji = "⚠️";
      title = "Subscription Cancelled";
      fields = [
        { title: "Customer", value: event.customer.email, short: true },
        { title: "Product ID", value: event.product_id, short: true },
        { title: "Cancellation Date", value: new Date(event.cancelled_at).toLocaleDateString(), short: true },
        { title: "Cancel at Next Billing", value: event.cancel_at_next_billing_date ? "Yes" : "No", short: true }
      ];
      break;
      
    case "refund.succeeded":
      color = "good";
      emoji = "💰";
      title = "Refund Processed";
      fields = [
        { title: "Amount", value: `${(event.amount / 100).toFixed(2)} ${event.currency || ""}`, short: true },
        { title: "Refund ID", value: event.refund_id, short: true },
        { title: "Payment ID", value: event.payment_id, short: true },
        { title: "Reason", value: event.reason || "Not specified", short: true }
      ];
      break;
      
    case "dispute.opened":
      color = "danger";
      emoji = "🚨";
      title = "New Dispute Opened";
      fields = [
        { title: "Payment ID", value: event.payment_id, short: true },
        { title: "Amount", value: `${(event.amount / 100).toFixed(2)} ${event.currency}`, short: true },
        { title: "Status", value: event.dispute_status, short: true },
        { title: "Stage", value: event.dispute_stage, short: true },
        { title: "Remarks", value: event.remarks || "No remarks", short: false }
      ];
      break;
      
    case "license_key.created":
      color = "good";
      emoji = "🔑";
      title = "License Key Created";
      fields = [
        { title: "License ID", value: event.id, short: true },
        { title: "Product ID", value: event.product_id, short: true },
        { title: "License Key", value: event.key.substring(0, 8) + "****", short: true },
        { title: "Expires", value: event.expires_at ? new Date(event.expires_at).toLocaleDateString() : "Never", short: true }
      ];
      break;
      
    default:
      // Handle any other events with a generic format
      color = "#3aa3e3";
      emoji = "ℹ️";
      title = webhook.eventType.replace(/_/g, ' ').replace(/\b\w/g, l => l.toUpperCase());
      fields = [
        { title: "Event Type", value: webhook.eventType, short: true },
        { title: "Timestamp", value: timestamp, short: true }
      ];
  }
  
  webhook.payload = {
    attachments: [{
      color: color,
      title: `${emoji} ${title}`,
      fields: fields,
      footer: "Dodo Payments",
      ts: Math.floor(new Date(webhook.payload.timestamp).getTime() / 1000)
    }]
  };

  return webhook;
}

Phương pháp hay nhất

Hãy áp dụng các phương pháp sau để giữ cho thông báo Slack hữu ích:

Sử dụng attachment message có màu sắc và các trường, để mỗi event rõ ràng và dễ xử lý.
Bao gồm dữ liệu quan trọng như amount, email của customer và ID, để team của bạn có thể nhanh chóng tìm thấy bản ghi.
Chọn màu phù hợp với loại event: xanh lá (good) cho thành công, đỏ (danger) cho dispute hoặc lỗi, vàng (warning) cho hủy, và xanh dương (#3aa3e3) cho các event mang tính thông tin.
Thêm timestamp (ts), để mỗi message hiển thị thời điểm event xảy ra.

Xử lý dữ liệu nhạy cảm: Không đăng các giá trị nhạy cảm như license key đầy đủ hoặc dữ liệu cá nhân lên Slack. Hãy cắt ngắn hoặc che các giá trị đó, giống như trường license key trong ví dụ cho tất cả event.

Khắc phục sự cố

Notifications Not Appearing in Slack

Kiểm tra để đảm bảo URL webhook Slack chính xác và Slack app tương ứng vẫn được cài đặt.
Kiểm tra để đảm bảo mã chuyển đổi là JavaScript hợp lệ.
Kiểm tra để đảm bảo các event đã đăng ký đang xảy ra. Để gửi một event, hãy sử dụng Send example trên tab Testing của endpoint.
Kiểm tra để đảm bảo Slack app đã bật Incoming Webhooks và có thể đăng lên channel.

Transformation Errors

Mở tab Logs trong Developer → Webhooks và kiểm tra response của lần gửi không thành công.
Kiểm tra để đảm bảo các field trong payload mà code của bạn đọc khớp với event payload của loại event đó.
Kiểm tra code bằng Simulate và một payload mẫu.
Kiểm tra để đảm bảo mỗi field mà code đọc đều tồn tại. Các field tùy chọn, chẳng hạn như error_message, có thể là null.

Missing Event Types

Kiểm tra để đảm bảo event đã được chọn trong Subscribed events. Để thay đổi lựa chọn, hãy mở endpoint và nhấp vào Edit.
Kiểm tra để đảm bảo Slack connector hỗ trợ event đó. Subscribed events chỉ liệt kê các event mà connector hỗ trợ.
Kiểm tra để đảm bảo transformation của bạn có case cho event đó. Các ví dụ giữ nguyên những event khác, và Slack sẽ từ chối chúng.

External Integrations

Messaging

Workflow Automation

CRM

Email

Analytics

Pricing

Giới thiệu

Bắt đầu

Ví dụ về mã chuyển đổi

Thông báo thanh toán cơ bản

Thông báo subscription đa dạng

Thông báo quản lý dispute

Handler cho tất cả event

Phương pháp hay nhất

Khắc phục sự cố

​Giới thiệu

​Bắt đầu

​Ví dụ về mã chuyển đổi

​Thông báo thanh toán cơ bản

​Thông báo subscription đa dạng

​Thông báo quản lý dispute

​Handler cho tất cả event

​Phương pháp hay nhất

​Khắc phục sự cố

Giới thiệu

Bắt đầu

Ví dụ về mã chuyển đổi

Thông báo thanh toán cơ bản

Thông báo subscription đa dạng

Thông báo quản lý dispute

Handler cho tất cả event

Phương pháp hay nhất

Khắc phục sự cố