通过 Webhook 接收 Drime Sign 事件

Webhook 会让 Drime 在您的签署请求每次发生变化时调用您的服务器。每次调用都是一个 JSON POST，并用密钥签名，让您的服务器可以确认调用来自 Drime。

#添加 Webhook

1. 打开设置 > 开发人员 > Webhook。

   您也可以从签署中点击偏好设置，打开 Webhook 标签页，然后点击打开开发者设置。

2. 点击添加 Webhook。

3. 在端点 URL 中，输入接收调用的服务器地址。

4. 在事件下，将每个要接收的事件设为打开，然后点击创建 Webhook。

   界面会显示已创建 Webhook。

5. 请立即复制密钥，然后点击完成。

   Webhook 密钥，请立即复制：密钥只会显示这一次。请将它存放在安全的地方。

#事件

#Drime 发送的内容

每次调用都带有以下请求头：

• X-Drime-Event：事件，例如 envelope.completed；

• X-Drime-Delivery：发送的编号；

• X-Drime-Signature：sha256= 加上用您的密钥计算的原始请求体 HMAC SHA-256。

JSON 请求体包含 event_type、event_uuid、timestamp 和 data，也就是相关文档及其签署人。Webhook 部分中的请求范例与签章验证提供了完整示例。

同一次发送可能会多次送达：请使用 event_uuid，确保每个事件只处理一次。

#验证签名

使用您的密钥计算原始请求体的 HMAC SHA-256，然后与 X-Drime-Signature 请求头比对。以 Node.js 为例：

import crypto from 'node:crypto';

function isFromDrime(rawBody, header, secret) {
  const expected = 'sha256=' + crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  return header.length === expected.length && crypto.timingSafeEqual(Buffer.from(header), Buffer.from(expected));
}

请使用收到时的原始请求体，不要先进行 JSON 解析。

#测试并跟踪发送情况

• 发送测试会发送一个测试事件：测试事件已排入队列，请查看发送记录。

• 发送记录会列出每次调用及其状态：成功、待处理或失败。重新发送可再次发送某次发送。

• 如果您的服务器没有响应或返回错误，Drime 会重试，在大约 34 小时内最多尝试 10 次。

• 打开 / 关闭开关可暂停 Webhook 而不删除：界面会显示已暂停 Webhook，重新开启时则显示已激活 Webhook。

#更换密钥或删除 Webhook

• 更换密钥会创建新的密钥。应用会警告（要重新产生密钥吗？您目前的密钥将立即失效。），请立即更新您的服务器。

• 删除会移除 Webhook：要删除此 Webhook 及其发送记录吗？

#遇到问题时

#后续步骤

• 开发应用或接入 Webhook

• 创建 API 令牌

• 已签署文档的审核证书包含哪些内容