如何通过DocuSign API获取Webhook状态及激活Webhook？

查询Webhook状态 #

调用GET /restapi/v2.1/accounts/{accountId}/connect/{connectId}接口时，返回的connect对象中包含isActive字段，该字段为布尔值：

• true 表示Webhook处于激活状态
• false 表示Webhook处于未激活状态

如果未找到该字段，检查请求是否返回了完整的响应结构，同时确认API调用的权限足够（需要账户级的Webhook管理权限）。

激活Webhook #

可以通过PUT /restapi/v2.1/accounts/{accountId}/connect/{connectId}接口来激活Webhook，请求体需包含Webhook的完整配置信息，并将isActive设置为true。示例请求体如下：

{
  "url": "https://your-webhook-endpoint.com",
  "name": "Your Webhook Name",
  "eventFilters": [
    {
      "eventType": "EnvelopeCompleted"
    }
  ],
  "isActive": true,
  "requireAcknowledgment": true,
  "signMessageWithX509Cert": false
}

注意：PUT请求需要传递Webhook的全部必要配置字段，不能仅修改isActive字段，否则会覆盖原有配置。

内容的提问来源于stack exchange，提问作者Emmanuel P.