服务中心

Webhook

在使用本用户手册中的功能前,需先了解不同版本对应的Webhook限制:
  • 体验版:不支持Webhook功能
  • 基础版:不支持Webhook功能
  • 专业版:支持Webhook功能

Webhook 是 eSignGlobal提供的异步事件通知服务,它允许用户通过配置回调 URL 接收系统中发生的各种事件通知。当指定事件发生时,系统会向用户配置的 URL 发送 HTTP POST 请求,包含事件的详细信息。用户可以选择订阅不同触发来源的事件,包括:

  • SaaS 页面发起:用户在 SaaS 平台上直接操作触发的事件。

  • 第三方系统集成发起:通过 APPID 集成的外部系统触发的数据变更事件。

Webhook 会实时将事件数据推送至您指定的回调地址,确保您能及时获取业务状态变更,实现自动化流程集成。

新增 Webhook

  1. 管理员可以在【设置-Webhook】菜单中点击【添加 Webhook】按钮新增 Webhook。

    image.png

  2. 请输入 Webhook 的必填信息后点击保存。

说明:

  • Webhook 名称: 便于识别的名称
  • 回调 URL: 接收通知的回调地址
  • 事件类型: 选择需要订阅的事件
  • 触发来源: 可以选择订阅不同触发来源的事件

image.png

  1. 为确保Webhook消息来源可信,系统提供密钥验证机制。保存成功后,系统生成密钥,请妥善保存。

    image.png

编辑 Webhook

  1. 在管理列表中,找到需要调整的Webhook,点击**[编辑]**按钮即可更新其设置。

注意:

  • 状态为停用时,可以编辑 webhook。

image.png

删除 Webhook

  1. 在管理列表中,找到需要删除的Webhook,点击**[删除]**按钮即可更新其设置。

注意:

  • 状态为停用时,可以删除 webhook。
  • 删除需要二次确认,请谨慎操作。

image.png

重置密钥

  1. 在管理列表中,找到需要删除的Webhook,点击**[重置密钥]**按钮即可重新生成新的密钥。

    image.png

  2. 密钥生成成功后,可以复制密钥。

    image.png

查看 Webhook

  1. 在 Webhook 列表,可以查看 Webhook 详情。

    image.png