数据推送

1. 简介

1.1 功能简介

数据推送(Webhook)是一种由开发人员自定义的回调机制,俗称“钩子”。它允许开发者通过配置自定义回调地址的方式,将 Web 应用中发生的特定事件实时推送至指定的服务器或 URL,从而实现跨平台、跨系统的数据联动与消息通知。

在简道云中,当表单数据或结构发生变更,亦或是流程状态与待办事项发生变化时,系统便会自动将相关操作及变更后的数据推送至您预先配置好的服务器地址。这些回调函数无需由 Web 应用官方维护,第三方开发人员同样可以对其进行自定义与管理,极大地提升了系统集成的灵活性。

1.2 使用场景

数据推送广泛适用于需要实时响应、自动触发、跨系统协作等场景中,如:

  • 系统集成:将简道云与第三方系统(ERP、OA 等)打通,实现数据自动同步,无需人工手动导入导出;
  • 消息通知:当表单中数据发生变更或流程状态更新时,自动触发通知,将信息推送到第三方系统中;
  • 数据实时同步:将简道云中的表单数据实时同步至企业自有数据库或其他业务系统,保证多端数据一致性。

1.3 版本说明

本功能为付费高级功能,需简道云企业版及以上版本可用。详情参见:官网定价

2. 设置步骤

2.1 设置入口

选择要设置数据推送的表单,点击「编辑表单 >> 扩展功能 >> 数据推送」,即可新建数据推送。

2.2 设置字段别名

字段别名是为表单字段设置的另一个名称标识,常用在数据推送、发送 API 请求和返回响应数据时,使用字段别名来替换字段 ID。提升数据的可读性、简化开发工作。

点击「设置字段别名」,在字段别名处填写对应字段的别名即可。如下所示:

注:

1)字段别名仅允许使用「小写字母」、「数字」和「下划线」组合,且必须以「小写字母」开头。

2)不允许设置字段别名为「data_id」。

2.3 字段对照表及JSON样例

字段对照表及 JSON 样例分别包含数据、表单、流程事件中全部字段,以及每个字段对应的字段名称、字段 ID/别名、字段类型、说明。开发人员写代码时可参照「字段对照表及 JSON 样例」进行书写。

2.4 表单数据结构

表单数据结构是指简道云在通过 Webhook 或 API 向外部系统推送数据时,数据所呈现的组织形式与层级关系。它以 JSON 格式为载体,完整描述了一条表单记录的所有信息,包括表单的基础元数据(如表单 ID、操作类型、时间戳等)以及各字段的具体取值。

3. 申请试用

标准版不包含 API 及 Webhook 功能,企业版及以上的用户可直接体验该功能,无需额外开通。

文档内容是否对您有帮助?
有帮助
没帮助没帮助
如需获取即时帮助,请联系技术支持
咨询
扫码领取100+零代码资料简道云官方微信号400-111-0890
图标在线咨询
立即体验