如何设置Web挂钩以检查DocuSign Envelope状态?

时间:2016-05-16 00:03:07

标签: docusignapi

我编写的代码使用信封来向客户端请求签名,如本教程中所示:

https://www.docusign.com/developer-center/recipes/request-a-signature-via-email-using-a-template

我的问题是,如何定义可用于更新信封状态的Web挂钩URL?我希望收到通知,并且能够在客户签署文档后更新我的数据库中的信封状态。这可能吗?

EnvelopeDefinition类是否公开了一些允许我定义web hook的url的属性?

3 个答案:

答案 0 :(得分:6)

webhook recipe显示如何在信封创建请求中包含eventNotification对象。

已添加

format of the webhook XML messages is documented

注意“连接”指南(第2页的2016年3月日期)已过时,在许多情况下不正确。新指南正在制作中。本指南对XML格式信息很有用。

WSDL文件,包括通知邮件格式为available.

要查看返回的XML消息,可以获得sentdelivered状态的通知示例。

最后,the recipe can be run, for free, on Heroku.

(您需要developer's account and integration key, all free, from DocuSign。)

在Heroku上运行时,您可以看到传入的通知消息。

答案 1 :(得分:3)

有两种方法可以做到这一点。

一种是在DS WebApp中设置帐户范围的Connect Connect,这会将发送/完成的每个信封上请求的事件通知发送到URL:https://www.docusign.com.au/sites/default/files/connect-guide_0.pdf#page=5

您还可以使用eventNotification参数定义每个信封。但是,参数未烘焙到提供的配方中。 编辑:我有所纠正,请参阅拉里的回复 https://www.docusign.com.au/p/RESTAPIGuide/Content/REST%20API%20References/Send%20an%20Envelope.htm

答案 2 :(得分:0)

测试“监听器”的另一种方法是使用

获得DocuSign XML响应。

https://webhook.site

从那里您将看到带有信封完整XML正文的POST请求。

首先测试创建信封

在测试我的监听器之前,我想确认我的C#代码将触发DocuSign信封中的WebHook(通过EnvelopeDefinition.EventNotification)。

EnvelopeDefinition.EventNotification为EnvelopeEvent和RecipientEvents设置2个对象列表。正确配置它们将在DocuSign Connect(Webhook)中触发触发器。

所需要做的只是设置 EventNotification.Url =在https://webhook.site

上为我创建的自定义URL

我在本地运行了C#API代码,以创建将触发Webhook的DocuSign信封。然后,我使用DocuSign电子邮件(在创建信封后收到的邮件)对文档进行签名-再次将Webhook触发了我的测试侦听器。

获取XML 我正确配置的代码触发了DocuSign Connect(Webhook)POST事件。我可以在https://webhook.site

的自定义URL上看到POST请求(及其XML正文)

重新发送XML 最后,复制从DocuSign发送的POST请求XML,并将该XML粘贴到PostMan中。然后,我可以在本地使用PostMan来“重新发送”该POST请求(和XML主体)以测试我正在开发的本地Listener API。