Docusign Connect JSON Webhooks 格式

Question

我在演示帐户 (Node.js) 中使用 Docusign Connect webhooks。

我正在测试使用每个信封配置接收 Webhooks，并希望以 JSON 格式而不是 XML 格式接收 Webhooks。

当我在帐户级别进行配置时，Webhook 附带 JSON 有效负载。然而，在每个信封配置中，它们仍然以 XML 形式出现。

此配置中是否已支持 JSON 负载？提到这里

我按照示例使用带有 eventData 的标准 eventNotification 对象：

eventData: {
            version: 'restv2.1',
            format: 'json',
            includeData: ['custom_fields', 'extensions', 'folders', 'recipients'],
        },

这可能是什么问题？

Answer 1

最常见的问题是您的 SIM 卡模组（SIM = 发送个人消息）。 Larry 的博客明确指出，只有使用聚合模式才能使用 JSON 格式，不支持单个消息。

要更改 SIM 模式，请转至 eSign 管理设置中的连接页面，然后选择您想要的模式。

Answer 2

支持连接写回的 JSON 格式。处理 eventNotifications 时，确定是否以 JSON 格式写回的部分。 XML 包含您位于此处的 eventData 参数。如果删除 eventData 部分，写回将以 XML 而不是 JSON 格式恢复。

XML 写回示例：

"eventNotification": {
        "url": "https://asdfasdf.proxy.webhookapp.com",
        "requireAcknowledgment": "true",
        "loggingEnabled": "true",
    "includeDocuments":"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"}
        ]
    }

JSON 写回示例：

"eventNotification": {
        "url": "https://asdfasdf.proxy.webhookapp.com",
        "requireAcknowledgment": "true",
        "loggingEnabled": "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"}
        ],
        "eventData": {
            "version": "restv2.1",
            "format":  "json",
            "includeData": ["custom_fields", "extensions", "folders",
                "recipients", "powerform", "tabs", "payment_tabs","documents"]
        }

我知道这张票有点陈旧，如果您仍然遇到问题并且需要一些帮助，请随时在支持人员的帮助下打开一张票，我自己或我团队中的某人会很乐意引导您完成此操作.