suprsend-workflow-schema

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

SuprSend workflows define notification logic as a sequence of nodes. Each workflow requires a trigger (event or API) and at least one delivery node. Between trigger and delivery, you can add function, branch, and data nodes to build sophisticated notification journeys.

Workflows are defined as JSON conforming to the schema at

https://schema.suprsend.com/workflow/v1/schema.json

For a complete guide on creating workflows using the JSON schema, see Workflow Schema Guide.

SuprSend 工作流将通知逻辑定义为一系列节点的序列。每个工作流都需要一个触发器（事件或 API）以及至少一个交付节点。在触发器和交付节点之间，你可以添加函数、分支和数据节点，以构建复杂的通知流程。

工作流需定义为符合

https://schema.suprsend.com/workflow/v1/schema.json

中 Schema 的 JSON 格式。

如需了解使用 JSON Schema 创建工作流的完整指南，请查看工作流 Schema 指南。

Workflow Nodes

工作流节点

Delivery Nodes

交付节点

Send notifications to users. Every workflow must end with at least one delivery or HTTP API node.

Node Type	Schema `node_type`	Description
Single Channel	`send_email` , `send_sms` , `send_whatsapp` , `send_inbox` , `send_mobile_push` , `send_webpush` , `send_slack` , `send_ms_teams`	Send via one channel
Multi-Channel	`send_multi_channel`	Send across multiple channels simultaneously
Smart Channel Routing	`send_smart_channel_routing`	Send sequentially across channels with delays until engagement

See Delivery Nodes Reference for configuration details and schema.

向用户发送通知。每个工作流必须以至少一个交付节点或 HTTP API 节点结束。

节点类型	Schema `node_type`	描述
单渠道	`send_email` , `send_sms` , `send_whatsapp` , `send_inbox` , `send_mobile_push` , `send_webpush` , `send_slack` , `send_ms_teams`	通过单一渠道发送通知
多渠道	`send_multi_channel`	同时通过多个渠道发送通知
智能渠道路由	`send_smart_channel_routing`	按顺序通过多个渠道发送通知，并设置延迟直至用户产生互动

查看交付节点参考获取配置细节和 Schema。

Function Nodes

函数节点

Control timing and aggregation of notifications.

Node Type	Schema `node_type`	Description
Delay	`delay`	Pause workflow for a fixed, dynamic, or relative duration
Batch	`batch`	Aggregate multiple triggers into one notification
Digest	`digest`	Send batched summary on a recurring schedule
Time Window	`timewindow`	Deliver only within specified day/time ranges

See: Delay, Batch, Digest, Time Window

控制通知的时序和聚合。

节点类型	Schema `node_type`	描述
延迟	`delay`	将工作流暂停一段固定、动态或相对时长
批量处理	`batch`	将多个触发器聚合为一条通知
摘要推送	`digest`	按重复的时间计划发送批量汇总通知
时间窗口	`timewindow`	仅在指定的日期/时间范围内发送通知

查看：延迟、批量处理、摘要推送、时间窗口

Branch Nodes

分支节点

Route notifications through different paths based on conditions.

Node Type	Schema `node_type`	Description
Branch	`branch`	If/else routing based on conditions
Wait Until	`branch_waituntil`	Pause until condition is met or timeout expires

See: Branch, Wait Until

根据条件将通知路由至不同路径。

节点类型	Schema `node_type`	描述
分支	`branch`	基于条件的 if/else 路由
等待直至	`branch_waituntil`	暂停工作流直至条件满足或超时

查看：分支、等待直至

Data Nodes

数据节点

Fetch, transform, or update data during workflow execution.

Node Type	Schema `node_type`	Description
Fetch	`httpapi_fetch`	GET data from an external API
Webhook	`httpapi_webhook`	Call external API (GET/POST/PUT/PATCH/DELETE)
Data Transform	`transform`	Generate or modify variables using Handlebars or JSONNET
Invoke Workflow	`invokeworkflow`	Trigger another workflow as a step
Update User Profile	`userupdate`	Modify recipient or actor profile properties

See: Fetch, Webhook, Transform, Invoke Workflow, User Update

在工作流执行期间获取、转换或更新数据。

节点类型	Schema `node_type`	描述
获取	`httpapi_fetch`	从外部 API 获取数据（GET 请求）
Webhook	`httpapi_webhook`	调用外部 API（支持 GET/POST/PUT/PATCH/DELETE 请求）
数据转换	`transform`	使用 Handlebars 或 JSONNET 生成或修改变量
调用工作流	`invokeworkflow`	将另一个工作流作为步骤触发
更新用户资料	`userupdate`	修改收件人或参与者的资料属性

查看：获取、Webhook、数据转换、调用工作流、用户资料更新

List & Object Nodes

列表与对象节点

Manage user list memberships and object subscriptions.

Node Type	Schema `node_type`	Description
Add User to List	`subscriberlistoperation_adduser`	Add recipient/actor to a list
Remove User from List	`subscriberlistoperation_removeuser`	Remove recipient/actor from a list
Subscribe to Object	`objectoperation_addsubscription`	Add user to an object subscription
Unsubscribe from Object	`objectoperation_removesubscription`	Remove user from an object subscription

See: List Operations, Object Operations

管理用户列表成员资格和对象订阅。

节点类型	Schema `node_type`	描述
添加用户至列表	`subscriberlistoperation_adduser`	将收件人/参与者添加至列表
从列表移除用户	`subscriberlistoperation_removeuser`	将收件人/参与者从列表移除
订阅对象	`objectoperation_addsubscription`	将用户添加至对象订阅
取消对象订阅	`objectoperation_removesubscription`	将用户从对象订阅移除

查看：列表操作、对象操作