跳转到内容

自动化

借助多维表格的自动化流程实现文档自动生成:当记录被创建、更新,或满足特定条件时自动生成文档。

  1. 进入模板标签页。
  2. 打开自动化部分,展开 HTTP 触发器。
  3. 复制提供的 Webhook 地址。
  1. 打开多维表格 → 自动化。
  2. 新建一个自动化流程。
  3. 添加触发条件(例如“当记录被创建时”)。
  4. 添加操作:发送 HTTP 请求。
  5. 配置:方法 = POST,URL = 复制的 Webhook 地址 + ?recordId={{record_id}}。
  6. 添加请求头:X-Webhook-API-Key: <您的 API 密钥>。

Webhook 地址格式:

https://api.automadoc.cc/api/webhook/templates/{templateId}/generate?recordId={recordId}

密钥可以是模板自己的密钥,也可以是公司 API 密钥(后者由应用管理员在企业门户的公司 → API 密钥下创建,适用于所有模板)。响应会列出本次启动的文档的 generationIds;可通过 GET /api/v1/documents/{generationId} 查询每份文档的状态。

如需把每份生成的文档发出签署,请为发送 HTTP 请求步骤添加 JSON 请求体(Content-Type: application/json):

{ "sign": {} }

签署人取自记录,按模板标签页中自动发起签署的设置确定;外部人员的链接和生成的密码会写回记录,供您的自动化流程通过邮件发送。如需在请求中直接指定签署人,请按角色传入 signers,格式与文档 API 相同。参见电子签名。

每种配置方法的最后一步都相同:发送 HTTP 请求,方法为 POST,URL 为 Webhook 地址加上 ?recordId= 和触发条件找到的记录的记录 ID,并添加请求头 X-Webhook-API-Key。只有触发条件不同。不同版本的飞书中,触发条件的名称可能略有差异。

新增记录时:为每条新记录生成一份文档,例如录入询价后立即生成报价单。选择新增记录的触发条件,以及对应的数据表。

修改记录时:记录变更时重新生成文档。选择修改记录的触发条件,并指定要监听的字段(例如只监听 Amount 和 Customer),以免无关的修改生成新文档。

记录满足条件时:在记录达到某个状态的那一刻生成文档,例如 Status 变为 Approved。这是最常用的配置:它只在条件开始成立时运行一次。

到达记录中的日期时:在记录中的某个日期生成文档,例如在 Due date 当天或提前七天生成催款函。选择日期字段和偏移时间。

定时触发:在设定的时间生成文档,例如每周一 9:00。定时触发本身没有对应的记录,因此请添加一个查找记录步骤(例如“Status 为 Open”),然后针对找到的记录、使用它们的记录 ID 发送 HTTP 请求。请在测试运行中确认每条记录只发送一次请求。

从集成平台 AnyCross 或任意 HTTP 客户端调用

Section titled “从集成平台 AnyCross 或任意 HTTP 客户端调用”

集成平台 AnyCross 和其他集成工具可以通过普通的 HTTP 请求节点调用 AutomaDoc。要从多维表格记录生成文档,请使用上面的 HTTP 触发器。要从不在多维表格中的数据(表单、ERP)生成文档,请使用文档 API,它以 JSON 接收数据:

设置 值
方法 POST
URL https://api.automadoc.cc/api/v1/templates/{templateId}/documents?wait=20
请求头 X-Webhook-API-Key:模板或公司的 API 密钥
请求头 Content-Type:application/json
请求体 {"data": { … 文档的各个字段 … }}

加上 ?wait=20 后,响应会在文档生成完成后返回,其中的 downloadUrl 可以传给下一个节点,用于在消息中附上文件,或保存到云盘。

当拒绝原因与您的套餐有关时,HTTP 触发器会返回 403,并在 JSON 正文中附带 code:

code 原因 处理方法
AUTOMATION_NOT_INCLUDED 贵公司没有专业版、没有进行中的试用,也没有 Business 席位。 在企业门户的账单页面购买 Business 席位或专业版。
QUOTA_EXCEEDED Business 席位包含的自动生成文档和每月免费额度均已用完,且文档包中已没有剩余文档。 在账单页面购买文档包,或等待下一个周期。
TEMPLATE_DISABLED 模板已锁定:贵公司的模板数量超出了套餐允许的上限。 在账单页面提高模板上限(套餐、席位或额外模板),或删除一个模板。被锁定的模板会在 24 小时内恢复。

缺少 X-Webhook-API-Key 时返回 401(API_KEY_MISSING),密钥错误或无法打开此模板时返回 403(API_KEY_INVALID)。

HTTP 触发器每个模板每分钟可接受 300 次请求,这是它独立的限制:飞书自动化对每条记录只发送一次且不会重试,因此不受文档 API 每分钟 60 次的限制。它生成的文档计入每家公司每分钟 600 份的限制,与文档 API 共用。超出任一限制时返回 429(RATE_LIMITED),该请求不会生成文档,因此请将非常大的导入分散到几分钟内完成。其他拒绝也都带有 code,例如 RECORD_ID_REQUIRED(400,缺少 recordId)和 WORKER_UNAVAILABLE(502,请稍后重试)。

在文档生成完成时接收通知,非常适合触发后续的自动化流程。

  1. 在模板标签页中,打开自动化部分并开启 Webhook 回调。
  2. 填写您的 Webhook 地址。
  3. 可选:添加 Bearer Token 用于鉴权。

AutomaDoc 会发送一个 POST 请求,请求体如下:

{
"url": "https://api.automadoc.cc/...?expires=...&signature=...",
"filename": "Invoice-INV-2024-001.pdf",
"fields": { "Customer_Name": "Acme Corp", "Total_Amount": "1,500.00" }
}
  • url:带签名的下载链接,有效期 2 小时。
  • filename:应用文件名模式后的最终文件名。
  • fields:本次生成所使用的记录中的简单值:文本、数字、日期等,与文档中打印的一致。关联记录、列表和附件不包含在内。
  • warnings:仅在生成时出现警告时提供,例如无法获取的图片(以字段名和 URL 的主机名标明)。

如果设置了 Bearer Token,它会通过 Authorization 请求头发送。

  • 触发后续的飞书自动化流程
  • 通过机器人发送飞书消息通知
  • 与飞书审批流程集成:如需在申请通过时生成文档,请参见审批文档,无需配置自动化
  • 将文档归档到飞书云文档或云盘