将应用程序连接到自动化

Automations is in Early access. Your workspace permissions determine which actions you can perform.

配置启动运行的事件

1. 创建一个自动化，将 Event from your application 设为触发器。
2. 设置 Event name，例如 order.created。名称区分大小写，可包含字母、数字、点、下划线或连字符。
3. 为应用程序发送的数据定义 Event fields。以订单为例，添加一个名为 order_id 的字符串字段。后续步骤可以使用这些字段。
4. 发布自动化。成功页面会显示 How to start a run，包括事件 URL 和请求示例。

模拟草稿或执行已发布版本

复制 URL 并发送事件

POST https://<your-regional-api-host>/v1/hooks/automations/<workspace-id>/<automation-id>

curl --request POST "$AUTOMATION_EVENT_URL" \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "order.created",
    "data": { "order_id": "order_123" }
  }'

继续一个正在等待事件的运行

1. 在 Automation settings 中，启用 Skip overlapping runs 和 Use a business key。将 Business key 设为能标识订单、发票或其他对象的值。以订单为例，使用表达式 trigger.data.data.order_id。
2. 添加 Wait for application event 并配置其事件名称、事件字段和超时时间。例如，等待 order.paid，包含一个字符串 payment_id 字段。
3. 发布后发送启动事件，等待其运行出现在 Runs 中。
4. 向同一 URL 发送后续事件，subject_key 等于该运行的业务键：

{
  "type": "order.paid",
  "subject_key": "order_123",
  "data": { "payment_id": "payment_456" }
}

已发布版本与暂停的自动化

处理投递和重试

排查事件问题

• 请求返回 4xx： 检查响应的错误详情、URL 以及必需的 type 和对象 data 字段。发送 Content-Type: application/json。整个请求体必须在 25 KB（25,000 字节）以内；超出限制的请求体会返回 413。
• 自动化尚未发布： 在发送事件之前先发布。被拒绝的事件不会保留；发布后请重新发送请求。
• The request returns 202 but no run starts: 检查自动化是否处于活跃状态、事件名称是否与触发器匹配，以及数据是否与已发布的事件字段一致。重叠保护可能会在另一个运行仍处于活跃状态时跳过新运行。还需检查每月运行配额；达到限额后被跳过的启动不会排入下个月的队列。
• 运行停留在等待步骤： 检查事件名称、精确的业务键、数据字段、过滤器和超时时间。使用运行原始已发布版本中的事件格式。
• 重试返回冲突： 使用原始键和未更改的请求进行重试。如果你打算发送不同的事件，请使用新的键。

后续步骤

• 打开 Automations 来配置和发布你的工作流。
• 在你的应用程序中处理幂等重试。
• 在运行中的工作流中等待事件。
• 浏览 Automations 指南。