SuperAPI AI 工具集

novu-design-workflow

通用与其它

查看项目

更新于 11-06 03:07

技能介绍

用途:该技能用于在编写前规划一个 Novu 工作流应具备的形态,例如渠道选择、是否设置 severity、是否标记为 critical、是否使用 digest 聚合、如何按订阅者在线状态调整路由,以及是否添加步骤条件与 HTTP 步骤。资料说明这些决策在 Dashboard 无代码编写和 @novu/framework 代码编写两种方式下保持一致,区别仅在语法。

主要能力:

  1. severity 与 critical 两个独立开关。severity 可选 LOW / MEDIUM / HIGH,默认不设置,用于 Inbox 中的视觉优先级(颜色、光晕),并影响 digest 跳过规则;critical 为 true/false,默认 false,为 true 时绕过订阅者偏好、跳过 digest、不加延迟、使用所有可用渠道。资料强调大多数工作流两者都不设置。
  2. 渠道选择。若用户明确指定渠道,则只用这些渠道,不添加回退或额外渠道;即使该渠道未在组织中配置,也按用户要求添加。若用户未指定,则从组织已配置渠道中按 In-App > Email > Chat > Push > SMS 的优先级最多选 3 个渠道。资料还给出各渠道适用与跳过场景。
  3. Digest 默认值。添加 digest 步骤时默认 type: "regular"、回看窗口 5 分钟、digest 时间 1 小时、key 为 subscriberId(对话类流程加 threadId);severity 为 HIGH 或 critical 为 true 时跳过 digest。
  4. 用户状态逻辑。在线时立即发送 In-App 并跳过 Push,按 severity 延迟 Email 或 Chat;离线时用 Push 或 Chat 获取注意。默认延迟 B2B 应用为下一个工作小时,B2C 应用约 30 分钟。
  5. 工作流模板。资料提供 9 个用例模板,包括订单确认、帖子评论、支付失败、账户停用、忘记密码、试用即将到期、显式渠道请求、Webhook 或外部 API 调用、先取数据再通知,每个模板给出 severity、critical 和步骤顺序等。
  6. 步骤条件。用于决定某步骤是否执行,例如订阅者离线才发送、In-App 未被查看才发邮件等;Dashboard 作者使用 JSON-Logic,Framework 作者传入 skip 回调,语义相同。

使用方式:在需要决定工作流长什么样时使用,例如设计订单确认流程、为支付失败选择渠道、将通知设为 critical、判断是否使用 digest、为离线订阅者添加回退、为某场景选择合适模板。设计完成后,若在 Dashboard 或通过 Novu MCP 编写,则用 dashboard-workflows/ 填写步骤内容(subject、body、editorType、headers、conditions);若用代码实现,则配合 framework-integration/ 使用 workflow()、step.*、controlSchema 和 Bridge Endpoint。

适用场景:Novu 工作流的前期设计决策,覆盖渠道、严重级别、关键性、聚合、条件与模板选择。

限制:资料明确该技能不用于触发已有工作流(见 trigger-notification/)、不用于编写代码封装(见 framework-integration/)、不用于在 UI 中渲染 severity(见 inbox-integration/)。资料还列出常见陷阱:不要默认设置 severity;critical 与 readOnly 不同;用户指定渠道时不要加回退;未指定渠道时最多 3 个;不要将 digest 与 critical 组合;对话类流程 digest key 需加 threadId;仅离线时用 Push;HTTP 步骤需 responseBodySchema 以便下游读取响应属性。具体实现代码与配置以官方文档为准。