LogoMkSaaS文档
LogoMkSaaS文档
首页模板介绍代码库视频教程入门文档环境配置
网站配置

功能集成

数据库身份验证邮件邮件订阅存储
支付
积分定时任务AI 功能统计分析通知验证码聊天框联盟营销

自定义

元数据字体主题图片国际化博客文档组件页面落地页用户管理密钥管理

代码库

IDE 设置项目结构格式化和代码检查更新代码库
X (Twitter)

通知

学习如何在 MkSaaS 中设置和使用通知

MkSaaS 支持在用户成功完成支付时发送通知,这允许您的团队在工具中接收实时订单提醒。

目前支持 Discord 和飞书两种通知渠道,并且易于扩展添加更多通知渠道。

设置

启用通知渠道

在 src/config/website.tsx 中启用通知功能,并配置接收消息的通知渠道:

src/config/website.tsx
export const websiteConfig: WebsiteConfig = {
  // ...other config
  notification: {
    enable: true,
    provider: 'discord', // or 'feishu'
  },
  // ...other config
}

配置 Webhook URL

根据选择的通知渠道,配置对应的 Webhook URL:

  1. 进入到 Discord 服务器并打开想要接收通知的频道
  2. 点击齿轮图标打开 Channel Settings
  3. 选择 Integrations > Webhooks > New Webhook
  4. 为 Webhook 设置名称和头像(可选)
  5. 复制 Webhook URL 并添加到环境变量文件中:
.env
DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/..."

如果您正在设置环境,现在可以回到环境配置文档并继续。本文档的其余部分可以稍后阅读。

环境配置

设置环境变量


通知消息示例

Discord 消息

Discord 通知作为带有绿色和结构化字段的消息发送,便于阅读。

Discord Message

飞书消息

飞书通知作为纯文本消息发送,所有购买信息清晰明了。

Feishu Message

扩展新的通知渠道

MkSaaS 支持扩展新的通知渠道:

  1. 在 src/notification 目录中创建新文件(例如 slack.ts)。
  2. 实现通知函数:
src/notification/slack.ts
export async function sendMessageToSlack(
  sessionId: string,
  customerId: string,
  userName: string,
  amount: number
): Promise<void> {
  try {
    const webhookUrl = process.env.SLACK_WEBHOOK_URL;
    if (!webhookUrl) {
      console.warn('SLACK_WEBHOOK_URL is not set, skipping Slack notification');
      return;
    }

    // Your Slack message implementation
    await fetch(webhookUrl, {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({
        text: `🎉 New Purchase\nUsername: ${userName}\nAmount: $${amount.toFixed(2)}`,
      }),
    });
  } catch (error) {
    console.error('Failed to send Slack notification:', error);
  }
}
  1. 在 notification.ts 中导入并调用此函数:
src/notification/notification.ts
import { sendMessageToSlack } from './slack';

// 添加到 sendNotification 函数中
await sendMessageToSlack(sessionId, customerId, userName, amount);

参考文档

  • Discord Webhooks 文档
  • 飞书 Webhook 文档

视频教程

下一步

邮件

配置邮件服务

身份验证

配置用户身份验证

统计分析

配置统计分析服务

存储

配置存储服务

统计分析

学习如何在MkSaaS 模板中设置和使用各种统计分析工具

验证码

学习如何在 MkSaaS 中设置和使用验证码

目录

设置启用通知渠道配置 Webhook URL通知消息示例Discord 消息飞书消息扩展新的通知渠道参考文档视频教程下一步