webhook事件通知文档不清楚



文档中关于enveloveDefinition类型中的eventNotification对象存在多个冲突。

第一个https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/Envelopes/create/#eventNotification显示以下

{
eventNotification:eventNotification{
eventData:connectEventData{
format:String,
version:String,
includeData:Array
}
}
}

而https://apiexplorer.docusign.com/#/esign/restapi?categories=Envelopes&tags=信封&operations=创建显示

{
eventNotification:eventNotification{
connectEventData:undeclared_type{
format:String,
version:String
}
}
}

目前尚不清楚其中哪一个是正确的。

其次https://developers.docusign.com/docs/platform/webhooks/connect/architecture

这在很大程度上意味着有效的版本和格式应该是v2.1和JSON,但是经过多次组合,我只能找回XML。我在文档中找不到任何列出允许的版本和格式的位置。

最后https://developers.docusign.com/docs/platform/webhooks/connect/configuration不是显示在https://admindemo.docusign.com/connect/edit-custom?accountId=\

由此产生的问题是:

有没有我在探险中错过的医生?如果没有,请回答以下问题。

什么是有效的格式、版本和includeData值?

包含这些字段的对象的名称是eventData还是connectEventData?

webhook支持XML以外的任何格式吗?

要从信封创建调用中定义的eventNotifications中获取json格式的连接消息,我可以参考这个博客了解一些详细信息-https://www.docusign.com/blog/developers/connect-webhooks-json-notifications.

它看起来像:

"事件通知":{"url":"https://yourwebhookurl","loggingEnabled":"真";,"requireAcknowledgement":"真";,"eventData":{"版本":"restv2.1";,"格式":"json";,"includeData":["选项卡"]},"enveloveEvents":[{"enveloveEventStatusCode":"Completed";,"includeDocuments":"false"}]}

请记住,SIM目前不可用于json,因此请确保您的帐户已设置为聚合消息。

联系支持后,我得到了以下答案:

计划发布JSON格式的Connect发布,但即将发布对于一些需要解决的性能问题已被推迟。不幸的是,这意味着文档编制有点提前。

通知格式如下:

"eventNotification": {
"url": "https://example/EventNotifications",
"loggingEnabled": "true",
"requireAcknowledgment": "false",
"envelopeEvents": [{
"envelopeEventStatusCode": "sent",
"includeDocuments": "false"
},
{"envelopeEventStatusCode": "delivered"},
{"envelopeEventStatusCode": "completed"},
{"envelopeEventStatusCode": "declined"},
{"envelopeEventStatusCode": "voided"}
]
}

最新更新