将Webhook与Docusign一起使用-我将能够获得自定义字段吗？ [英] Using webhook with Docusign - will I be able to get custom fields?

问题描述

我创建了一个带有一个签名者，1个模板，3个不同文档的信封。我在信封中添加了一个自定义字段。我送出信封，并在我指定的URL上获得响应。我查看了回复，但没有看到自定义信封字段。是否应该将其与响应一起发送？这是我发送的：

I created an envelope with one signer, 1 template, 3 different docs. I added a custom field to the envelope. I send off the envelope and get the response back on the url I specified. I look at the response and I don't see the custom envelope field in there. Should it be sent along with the response? Here is what I sent:

 {
  "customFields": {
    "textCustomFields": [
      {
        "name": "file id",
        "value": "1823456"
      }
    ]
  },
  "eventNotification": {
    "url": "http://requestb.in/16avl8c1",
    "loggingEnabled": "true",
    "requireAcknowledgment": "true",
    "envelopeEvents": [
      {
        "envelopeEventStatusCode": "Delivered"
      },
      {
        "envelopeEventStatusCode": "Completed"
      },
      {
        "envelopeEventStatusCode": "Declined"
      },
      {
        "envelopeEventStatusCode": "Voided"
      },
      {
        "envelopeEventStatusCode": "Sent"
      }
    ],
    "useSoapInterface": "false",
    "includeCertificateWithSoap": "false",
    "signMessageWithX509Cert": "false",
    "includeDocuments": "false",
    "includeEnvelopeVoidReason": "false",
    "includeTimeZone": "true",
    "includeSenderAccountAsCustomField": "true",
    "includeDocumentFields": "true",
    "includeCertificateOfCompletion": "false"
  },
  "compositeTemplates": [
    {
      "compositeTemplateId": "1",
      "serverTemplates": [
        {
          "sequence": "1",
          "templateId": "a0d319ef-ad34-4a2e-a375-069ce2df630c"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "2",
          "recipients": {
            "signers": [
              {
                "name": "Kathy Gilbert",
                "email": "[e-mail]",
                "recipientId": "1",
                "routingOrder": "1",
                "roleName": "##Buyer1"
              }
            ]
          }
        }
      ],
      "document": {
        "documentId": "1",
        "name": "Here is document one of the test.docx",
        "fileExtension": "docx",
        "documentBase64": [bytearray]
      }
    },
    {
      "compositeTemplateId": "2",
      "serverTemplates": [
        {
          "sequence": "1",
          "templateId": "a0d319ef-ad34-4a2e-a375-069ce2df630c"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "2",
          "recipients": {
            "signers": [
              {
                "name": "Kathy Gilbert",
                "email": "[e-mail]",
                "recipientId": "1",
                "routingOrder": "1",
                "roleName": "##Buyer1"
              }
            ]
          }
        }
      ],
      "document": {
        "documentId": "2",
        "name": "Here is document two of the test",
        "fileExtension": "docx",
        "documentBase64": [bytearray]
      }
    },
    {
      "compositeTemplateId": "3",
      "serverTemplates": 
        {
          "sequence": "1",
          "templateId": "a0d319ef-ad34-4a2e-a375-069ce2df630c"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "2",
          "recipients": {
            "signers": [
              {
                "name": "Kathy Gilbert",
                "email": "[e-mail]",
                "recipientId": "1",
                "routingOrder": "1",
                "roleName": "##Buyer1"
              }
            ]
          }
        }
      ],
      "document": {
        "documentId": "3",
        "name": "Here is document three of the test",
        "fileExtension": "docx",
        "documentBase64": [bytearray]
      }
    }
  ],
  "status": "sent",
  "emailSubject": "Please sign the following document at 3:20 PM"
}

推荐答案

Connect webhook响应将包含信封自定义字段（如果已将其添加到）

Connect webhook response will contain the Envelope Custom Fields if they were added to the envelope successfully.

对于CompositeTemplates，在根级别指定的CustomFields将被忽略。您应该在内联模板中指定自定义字段。

For CompositeTemplates the CustomFields specified at the root level are ignored. You should specify the Custom Fields within the inline template.

故障排除提示：您可以执行其他检查，以查看是否使用 listCustomFields api。

Troubleshooting Tip:You can do an additional Check to see if the Custom Fields are created by using listCustomFields api.

这里是一个例子。

"compositeTemplates": [
    {
        "compositeTemplateId": "1",
        "serverTemplates": [
            {
                "sequence": "1",
                "templateId": "a0d319ef-ad34-4a2e-a375-069ce2df630c"
            }
        ],
        "inlineTemplates": [
            {
                "sequence": "2",
                "customFields": {
                   "textCustomFields": [
                   {
                    "name": "file id",
                    "value": "1823456"
                   }
                  ]
                },
                "recipients": {
                    "signers": [
                        {
                            "name": "Kathy Gilbert",
                            "email": "[e-mail]",
                            "recipientId": "1",
                            "routingOrder": "1",
                            "roleName": "##Buyer1"
                        }
                    ]
                }
            }
        ]
    }

这篇关于将Webhook与Docusign一起使用-我将能够获得自定义字段吗？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！