配置新 Webhook

配置选项

配置 Webhook 需要定义五个元素：

• 名称 - 建议使用其他管理员可轻松理解的直观名称。
• 范围 - Webhook 捕捉的网络范围是多少？ “帐户”和“组”在界面中可用。
  • 此 API 支持“帐户”、“组”、“用户”和“资源”范围。
  • 每个 Webhook 只能定义一个范围。
• URL - Acrobat Sign 会将 JSON 负载推送到的目标 URL。
• 事件 - 导致 Acrobat Sign 生成 JSON 并将其推送到 URL 的触发器。
  • 每个事件都会生成与触发器事件相关的不同负载。
  • 多个事件可包括在一个 Webhook 中。
• 通知参数 - 通知参数识别事件 JSON 负载部分，从而允许您仅选择对此 Webhook 而言重要的事件部分（因此，可减少发送到 URL 的不必要数据）。

完全定义 Webhook 后，单击保存，然后新的 Webhook 会立即开始响应触发器事件。 

范围

• 帐户：帐户中发生的触发推送的所有已订阅事件。
  
  • 帐户管理员有权查看为帐户和该帐户中的所有组定义的所有 Webhook。
• 组：该组中发生的触发推送的所有已订阅事件。 注意：组范围的 Webhook 仅存在于该组中。
  • 组管理员将仅看到专用于此组的 Webhook。 他们无法看到帐户级别 Webhook 或绑定到其他组的 Webhook。
  • 已启用位于多个组的用户的帐户将看到设置应该应用于范围组的选项。
    
• 用户帐户：触发推送的用户帐户触发器的所有已订阅事件。 用户级别 Webhook 仅可通过 API 创建。
• 资源级别 Webhook：这将针对特定资源创建。 特定于此资源的事件将推送至 Webhook URL。 资源级别 Webhook 仅可通过 API 创建。

URL

Webhook URL 是一个侦听在发生事件时触发的传入 HTTPS POST 通知消息的服务器。

您需要此 URL 以订阅 Webhook 事件。

• 客户端必须包括 Acrobat Sign 可 POST 到的 HTTPS URL。 此 URL 必须在公共互联网上可用。  
  • 例如，127.0.0.1 和 localhost URI 无效。
  • URL 端点必须侦听端口 443 或 8443（由客户在定义回调 URL 时决定）。
• 确保 Webhook 支持传入事件通知的 POST 请求和验证请求的 GET 请求。
• URL 不应被防火墙阻止。

事件

以下是可以触发推送到 Webhook URL 的事件，这些事件按对象分组并按 UI 中的顺序列出。

左侧的值是您将在 Acrobat Sign UI 中看到的值。 右侧的值是 API 中的 Webhook 名称。

有关 Webhook 及其负载的完整详细信息，请参阅 Acrobat Sign 开发人员指南。

协议：

批量发送：

Web 表单：

库模板（仅限 API）：

通知参数

通知参数允许您仅将 JSON 负载自定义为事件的特定元素。

例如，在已替换协议参与者事件中，您可能仅想要获取协议信息和参与者信息，忽略文档信息，且减小发送到 Webhook URL 的 JSON 总大小。

• 协议
  • 协议信息 - 基于触发事件时协议状态的详细协议信息。
  • 协议文档信息- 包括由于事件而生成的任何文档信息。
  • 协议参与者信息 - 包括由于事件而生成的任何参与者信息。
  • 协议已签署文档 - 提供已签名的 PDF。 
    • 适用于已完成协议工作流程和协议所有事件。
• 批量发送
  
  • 批量发送信息 - 有关触发事件的批量发送对象的详细信息。
• Web 表单
  • 构件信息 - 有关触发事件的 Web 表单的详细信息。
  • 构件文档信息 - 与 Web 表单相关的文档信息。
    
  • 构件参与者信息 - 有关 Web 表单中已定义参与者的信息。