上次更新日期：
2025年11月5日
配置选项
配置 Webhook 需要定义五个元素：
- 名称 - 建议使用其他管理员可轻松理解的直观名称。
- 范围 - Webhook 捕捉的网络范围是多少？ “帐户”和“组”在界面中可用。
- 此 API 支持“帐户”、“组”、“用户”和“资源”范围。
- 每个 Webhook 只能定义一个范围。
- URL - Acrobat Sign 会将 JSON 负载推送到的目标 URL。
- 事件 - 导致 Acrobat Sign 生成 JSON 并将其推送到 URL 的触发器。
- 每个事件都会生成与触发器事件相关的不同负载。
- 多个事件可包括在一个 Webhook 中。
- 通知参数 - 通知参数识别事件 JSON 负载部分，从而允许您仅选择对此 Webhook 而言重要的事件部分（因此，可减少发送到 URL 的不必要数据）。
完全定义 Webhook 后，单击保存，然后新的 Webhook 会立即开始响应触发器事件。
注释
请根据上述验证协议配置您的 Webhook URL，以响应 Webhook 验证和 Webhook 通知请求。 将发送至从 Acrobat Sign Web 应用程序创建的 Webhook 的客户端 ID（应用程序 ID）将为 - UB7E5BXCXY
范围
- 帐户：帐户中发生的触发推送的所有已订阅事件。
- 帐户管理员有权查看为帐户和该帐户中的所有组定义的所有 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 开发人员指南。
协议：
| UI 元素 | Webhook 名称 |
| 协议所有事件 | AGREEMENT_ALL |
| 已创建协议 | AGREEMENT_CREATED |
| 已发送协议 | AGREEMENT_ACTION_REQUESTED |
| 协议参与者已完成 | AGREEMENT_ACTION_COMPLETED |
| 已完成协议工作流程 | AGREEMENT_WORKFLOW_COMPLETED |
| 协议已过期 | AGREEMENT_EXPIRED |
| 已删除协议 | AGREEMENT_DOCUMENTS_DELETED |
| 已取消协议 | AGREEMENT_RECALLED |
| 已拒绝协议 | AGREEMENT_REJECTED |
| 已共享协议 | AGREEMENT_SHARED |
| 协议已取消共享 | AGREEMENT_UNSHARE |
| 协议已自动取消共享 | AGREEMENT_UNSHARE_AUTO |
| 已委派协议 | AGREEMENT_ACTION_DELEGATED |
| 已替换协议参与者 | AGREEMENT_ACTION_REPLACED_SIGNER |
| 已修改协议 | AGREEMENT_MODIFIED |
| 已确认协议修改 | AGREEMENT_USER_ACK_AGREEMENT_MODIFIED |
| 已查看协议电子邮件 | AGREEMENT_EMAIL_VIEWED |
| 已退回协议电子邮件 | AGREEMENT_EMAIL_BOUNCED |
| 协议 WhatsApp 被退回 | AGREEMENT_WHATSAPP_BOUNCED |
| 协议短信被退回 | AGREEMENT_SMS_BOUNCED |
| 已查看协议文档 | AGREEMENT_DOCUMENTS_VIEWED |
| 在已应用密码来查看文档的情况已查看协议文档 | AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED |
| 协议创建失败 | AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| 协议已在脱机事件完成后同步 | AGREEMENT_OFFLINE_SYNC |
| 已安全保存协议 | AGREEMENT_VAULTED |
| 已对协议参与者进行社会身份验证 | AGREEMENT_WEB_IDENTITY_AUTHENTICATED |
| 已对协议参与者进行 KBA 身份验证 | AGREEMENT_KBA_AUTHENTICATED |
| 协议参与者已通过电子邮件 OTP 身份验证 |
AGREEMENT_EMAIL_OTP_AUTHENTICATED |
| 已更新协议到期日期 | AGREEMENT_EXPIRATION_UPDATED |
| 已发送协议提醒 | AGREEMENT_REMINDER_SENT |
| 协议签名者姓名被签名者更改 | AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER |
| 已发起协议提醒 | AGREEMENT_REMINDER_INITIATED |
| 协议 Webhook 仅通过 API 提供 | |
| UI 元素 | Webhook 名称 |
| 不适用 |
AGREEMENT_READY_TO_NOTARIZE |
| 不适用 |
AGREEMENT_READY_TO_VAULT |
批量发送：
| UI 元素 | Webhook 名称 |
| “批量发送”所有事件 | MEGASIGN_ALL |
| 已创建“批量发送” |
MEGASIGN_CREATED |
| 已共享“批量发送” |
MEGASIGN_SHARED |
| 已召回“批量发送” |
MEGASIGN_RECALLED |
| 已发送“批量发送”提醒 | MEGASIGN_REMINDER_SENT |
| 已发起“批量发送”提醒 | MEGASIGN_REMINDER_INITIATED |
Web 表单：
| UI 元素 | Webhook 名称 |
| Web 表单所有事件 | WIDGET_ALL |
| 已创建 Web 表单 |
WIDGET_CREATED |
| 已启用 Web 表单 |
WIDGET_ENABLED |
| 已禁用 Web 表单 |
WIDGET_DISABLED |
| 已修改 Web 表单 |
WIDGET_MODIFIED |
| 已共享 Web 表单 |
WIDGET_SHARED |
| Web 表单创建失败 |
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM |
库模板（仅限 API）：
| UI 元素 | Webhook 名称 |
| 不适用 | LIBRARY_DOCUMENT_ALL |
| 不适用 | LIBRARY_DOCUMENT_CREATED |
| 不适用 | LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| 不适用 | LIBRARY_DOCUMENT_MODIFIED |
通知参数
通知参数允许您仅将 JSON 负载自定义为事件的特定元素。
例如，在已替换协议参与者事件中，您可能仅想要获取协议信息和参与者信息，忽略文档信息，且减小发送到 Webhook URL 的 JSON 总大小。
- 协议
- 协议信息 - 基于触发事件时协议状态的详细协议信息。
- 协议文档信息- 包括由于事件而生成的任何文档信息。
- 协议参与者信息 - 包括由于事件而生成的任何参与者信息。
- 协议已签署文档 - 提供已签名的 PDF。
- 适用于已完成协议工作流程和协议所有事件。
- 批量发送
- 批量发送信息 - 有关触发事件的批量发送对象的详细信息。
- Web 表单
- 构件信息 - 有关触发事件的 Web 表单的详细信息。
- 构件文档信息 - 与 Web 表单相关的文档信息。
- 构件参与者信息 - 有关 Web 表单中已定义参与者的信息。
