NeboAI
NeboAI
开始使用

触发器

触发器决定工作流何时运行。Nebo 有七种触发器类型。每种都是一个对象,包含一个 type 字段以及该类型对应的字段。

类型运行时机
schedulecron 表达式匹配时。
heartbeat经过一个时间间隔时,可选限定在每天的某个时间段内。
event发出来源匹配的事件时。
watch插件监听器写出一行输出时。
folder文件夹中的文件发生变化时。
manual所有者或某位员工运行它时。
call电话线路响铃时。仅用于电话呼叫树。

schedule

{ "type": "schedule", "cron": "0 8 * * 1-5", "schedule": "Weekdays at 8:00" }

cron 是一个五字段的 cron 表达式:分钟、小时、日、月、星期。schedule 是可选的、供人阅读的说明。计划按机器人的本地时区运行。Nebo 每五秒检查一次计划。机器人关闭期间错过的触发,如果延迟不到一小时,会补运行一次。上一次运行仍在进行时,本次触发会被跳过。

heartbeat

{ "type": "heartbeat", "interval": "30m", "window": "08:00-18:00" }

interval 是一个时长,例如 30m、1h 或 2h30m。window(HH:MM-HH:MM)让触发保持在工作时间内。下一次触发时间为上一次触发加上间隔,并调整到时间窗口内;第一次触发在工作流加载一个间隔之后。计时器在重启后依然保留。上一次运行仍在进行时,本次触发会被跳过;无效的间隔永远不会触发。

event

{ "type": "event", "sources": ["support-coordinator.summary.ready", "assignment.*"] }

sources 列出要完全匹配的事件名称,或带结尾 .* 通配符的名称。空列表属于错误,会导致整个 agent.json 被拒绝。运行会收到 _event_source、_event_payload 和 _event_origin。名称如何构成,参见事件。

watch

{ "type": "watch", "plugin": "mail", "event": "email.new" }

watch 会让一个插件进程持续运行,并针对它写出的每一行启动一次运行。每一行都以 _watch_payload 的形式传入。十分钟内完全相同的行会被丢弃。

字段默认值含义
plugin必填一种能力(例如 mail),或一个插件的 slug。只要有合适的能力,就写能力。
event无插件 events 列表中的一个事件。Nebo 会使用该事件的命令,并把每一行也作为 <plugin>.<event> 发出。
command无启动监听器的参数。设置后使用该值;否则从 event 获取。
restart_delay_secs5监听器退出后重启前的等待时间。

能力会解析为提供该能力的已安装插件,并优先选择该员工有账户的插件。如果没有这样的插件,工作流会被标记为降级状态,并告诉所有者需要连接什么。不断崩溃的监听器会延迟重启,延迟时间加倍增长,最长 300 秒,连续运行 30 秒后重置。

{ "type": "watch", "plugin": "notes-sync", "command": "watch --notebook {{notebook}} --format ndjson" }

command 中的 {{key}} 会用所有者对员工输入项的回答来填充。如果某个占位符没有答案,监听就不会启动。

folder

{ "type": "folder", "path": "{{inbox_folder}}", "extensions": ["pdf"], "recursive": false }
字段默认值含义
path必填文件夹的绝对路径。{{key}} 会用输入值填充。
extensions所有文件要匹配的文件扩展名,不带点。
recursivetrue包含子文件夹。
debounce_secs2在此时间窗口内的变更会合并为一次运行。

运行会在 _watch_payload.files 中收到发生变化的路径。

manual

{ "type": "manual" }

manual 工作流只在所有者运行它或员工调用 run_workflow 时运行。任何工作流,无论触发器是什么,也都可以用这种方式运行。

call

{"type": "call", "line": "..."} 仅在 "type": "call_tree" 类型的工作流中有效,该工作流用于配置员工如何接听电话线路。line 为空时,适用于该员工接听的、没有更具体呼叫树的所有线路。一个呼叫树必须恰好有一个问候语,并且至少有一个命名意图。

Webhook

所有者也可以为员工创建 webhook。关联了工作流的 webhook 会运行该工作流;没有关联工作流的 webhook 会把它的负载发送到员工的聊天中。