步骤选项
下面的表格按应用中的标签命名步骤带有的每个字段,并给出它保存的值。MCP 工具和导出使用的是同样的结构,所以它是任何人自动化 Pyn 时的参考。
每个步骤都有的字段
Section titled “每个步骤都有的字段”| 字段 | 应用中的标签 | 值 |
|---|---|---|
id |
Pyn 分配的唯一 id。 | |
title |
步骤标题 | 自由文本;为空时显示步骤类型。 |
type |
在 Add Step 中选择 | send-message、send-channel-message、invite-to-calendar-event、send-channel-invite、raise-ticket、add-message-to-context;见下文。 |
state |
Enabled / Disabled | enabled 或 disabled。已禁用的步骤从不发送。 |
schedule.type |
自动化流程中为 relative 或 elapsed(After trigger),活动中为 absolute。 |
|
schedule.offset |
Schedule | 对 relative:一个时长,例如 { "days": -7 } 或 { "weeks": 2 };负数表示参考日期之前。对 elapsed:触发时刻之后的正时长,以 minutes、hours、days 或 weeks 计,例如 { "hours": 1 };{} 表示 Immediately。 |
schedule.date |
Scheduled date | 对 absolute:一个日历日期,2026-03-02。 |
schedule.hour、schedule.minute |
at | 0 到 23 和 0 到 59。 |
schedule.timezone |
in | recipient,或一个时区名称,例如 Australia/Sydney。 |
schedule.deliverOn |
Days of Week | MONDAY 到 SUNDAY 中的一个或多个。 |
schedule.onSkippableDate |
On Non-Delivery Days | deliver-anyway、deliver-before(前一个投递日)或 deliver-after(下一个投递日)。 |
audience |
Audience 标签页 | lifecycle(current、joiner、leave、terminated 中的任意几个)、includeGroups、excludeGroups(群组 id)。缺省表示仅在职员工。 |
skipIfOverdue |
Skip if overdue at enrollment | true 表示某人注册时日期已过的步骤会被跳过。 |
reminders |
Reminders | 步骤侧面板中最多三条(到三条时 Add reminder 消失),每条带 offset(发送后的天数)、enabled 和一个侧面板不设置的可选 message。通过 API 或 MCP 服务器写入的步骤最多可以携带十条。 |
schedule.hour、schedule.minute、schedule.timezone、schedule.deliverOn 和 schedule.onSkippableDate 只存在于 relative 或 absolute 排期上。elapsed 排期只带 type 和 offset,活动步骤不能使用它。
send-message(私信或电子邮件)和 send-channel-message(频道帖子)增加:
| 字段 | 标签 | 值 |
|---|---|---|
medium |
由步骤类型固定 | slack 或 email。 |
sender |
From | 一个发件人 id。缺省表示工作区默认值。 |
conditionalSender |
From | 一个条件发件人 id。一个步骤有 sender 或 conditionalSender 之一,永远不会两者都有。 |
recipient |
To | 一个收件人,见下文。频道帖子的收件人是一个频道。 |
ccRecipients |
Cc | 收件人,数量任意,位于步骤侧面板中 To 旁边的 Cc 链接后面。 |
subject |
Subject | 一个单行文档。在电子邮件上,它是主题;在 Slack 私信上,它是设置了 fallbackToEmail 时所发送电子邮件的主题。 |
message |
编辑器 | 编排式消息。 |
body、html |
Email body | Raw HTML 电子邮件为 body: "html",Liquid HTML 放在 html 中;否则编排式 message 就是正文。仅限电子邮件。 |
emailFormat |
Email format | left 或 full-width;缺省表示 Centered。只为编排式电子邮件排版;Raw HTML 电子邮件按原样发送。 |
hideSignature |
Include the sender’s signature (verified email senders) | 开关取消勾选时为 true;缺省表示已验证的电子邮件发件人的签名附在电子邮件末尾。仅限编排式电子邮件。 |
deactivateUnfurlLinks、deactivateUnfurlMedia |
Advanced | true 表示关闭 Slack 预览。 |
fallbackToEmail、fallbackEmailSender |
Send by email if the recipient is not in Slack,以及它下方的 From | 在 Slack 私信上为 true,并带一个电子邮件发件人的 id:不在 Slack 上的收件人会通过电子邮件收到消息,由该发件人发出,主题为步骤的 subject。设置了 fallbackToEmail 却缺少发件人或主题时,自动化流程无法发布。见有人不在 Slack 上时通过电子邮件发送私信。 |
escalations |
Escalations | 最多三条,每条带 offset(发送后的天数)、recipient(除群组或条件收件人以外的任何收件人)和 enabled。 |
| 形式 | 标签 | 字段 |
|---|---|---|
| 相对 | Employee、Manager、Skip-level Manager、Buddy、HRBP | type: "relative",recipient 为 employee、manager、skip-manager、buddy、hrbp 之一;可选的 address 为 primary 或 personal。 |
| 一个人 | People | type: "employee",recipient 为员工 id,可选的 address。 |
| 一个群组 | Groups(活动步骤) | type: "group",recipient 为群组 id。每个成员都收到该步骤。 |
| 一个频道 | Channels | type: "channel",recipient 为频道 id。 |
| 一个自定义电子邮件地址 | Custom Email Recipients | type: "custom-email",recipient 为自定义电子邮件收件人 id。 |
| 一个条件收件人 | Conditional Recipients | type: "conditional",recipient 为条件收件人 id。根据它的规则为每位已注册员工解析;活动步骤上会被拒绝。 |
其他步骤类型
Section titled “其他步骤类型”| 类型 | Add Step 中的标签 | 额外字段 |
|---|---|---|
invite-to-calendar-event |
Invite to Calendar Event | recipient(默认为 Employee;侧面板没有它的控件);eventId(日历事件);inviteTo 为 next-occurrence、next-occurrence-reference-date 或 all-occurrences。 |
send-channel-invite |
Add to Channel | sender;recipient(被添加的人);channel(频道 id);medium: "slack"。 |
raise-ticket |
Raise Ticket | integration(Jira 连接)、project、issueType、summary(单行)、description;medium: "jira"。没有收件人。 |
add-message-to-context |
Add Message to Employee Context 及其他 AI & Context 行 | recipient(谁的上下文)。 |
活动模板里程碑
Section titled “活动模板里程碑”活动模板是一份里程碑列表,每个里程碑带 id、title、emoji、color(十六进制颜色)、date(日历日期)和 steps(如上所述的步骤,使用绝对排期)。注册一个里程碑会把它变成一个以该日期为参考日期的活动。见活动模板。
- 设置步骤排期,了解应用中显示的排期字段。
- 选择收件人和抄送,了解收件人的形式。
- 令牌,了解
message和html里放什么。 - For agents,了解本站的机器可读输出。