DocuSign API：嵌入式签名仪式的 webhook 通知

Question

虽然我们可以接收 email 签名的 webhook 消息，但似乎 DocuSign 不会为嵌入式 session 签名发送 webhook 事件。 这行得通吗？

Answer 1

是的，Connect 可以触发嵌入式签名事件的事件。

您使用的是帐户级别的 Connect 配置，还是信封级别的 EventNotifications？

Answer 2

与嵌入式签名 session 相关的事件是recipient事件，而不是更广泛的envelope事件。 -- 因此，请检查您的 Connect 订阅是否要求正确的事件。 例如，recipient_completed，而不仅仅是信封_completed。

此外，默认的 Connect 排队策略通常会结合几乎同时发生的事件的通知。

例如

1. 收件人 1 标志（通过嵌入式仪式或电子邮件发起的仪式）
2. 信封现已完成（收件人 1 是信封的最后一个收件人）

如果您已询问收件人和信封事件，通常只会针对上述两个事件通知您一次。

如果您需要针对上述每个事件的单独通知，请切换到使用 SIM 队列进行 Connect。 这是通过电子签名管理工具的更新部分在帐户级别完成的。

Answer 3

Docusign 通过两种方式支持 webhook 事件 -

1. 帐户级别 - 连接配置：为此，您需要配置 webhook URL。 Go 到 Docusign 管理页面 -> 在集成下，select “连接” -> 添加配置 -> 自定义 -> 指定 webhook ZE6B391A8D2C4D45902A23A8B6585703DD 和触发事件。 这将适用于该帐户的所有信封。

2. 信封级别：在 createEnvelope 请求中添加以下内容：

 "eventNotification": { "URL": "<webhookurl>", "loggingEnabled": "true", "requireAcknowledgment": "true", "useSoapInterface": "false", "includeCertificateWithSoap": "false", "signMessageWithX509Cert": "false", "includeDocuments": "true", "includeEnvelopeVoidReason": "true", "includeTimeZone": "true", "includeSenderAccountAsCustomField": "true", "includeDocumentFields": "true", "includeCertificateOfCompletion": "true", "envelopeEvents": [ {"envelopeEventStatusCode": "sent"}, {"envelopeEventStatusCode": "delivered"}, {"envelopeEventStatusCode": "completed"}, {"envelopeEventStatusCode": "declined"}, {"envelopeEventStatusCode": "voided"} ], "recipientEvents": [ {"recipientEventStatusCode": "Sent"}, {"recipientEventStatusCode": "Delivered"}, {"recipientEventStatusCode": "Completed"}, {"recipientEventStatusCode": "Declined"}, {"recipientEventStatusCode": "AuthenticationFailed"}, {"recipientEventStatusCode": "AutoResponded"} ] }

这仅适用于该信封。

您可以配置要触发 webhook URL 的事件。

DocuSign 使用 XML 在相应事件上点击 webhook，其中包含有关信封和收件人事件的所有信息。 如果您不想接收 XML 中的签名文档，您也可以配置。