DocuSign:是否可以通过PowerForm链接发送自定义有效负载并通过webhook取回? [英] DocuSign: Is it possible to send a custom payload via PowerForm link and get it back via webhook?

问题描述

我正在与DocuSign API集成，我想知道是否有可能实现以下方案:

I am integrating with DocuSign APIs and I wonder if it's possible to pull off the following scenario:

1. 获取PowerForm以获得其URL
2. 将自定义有效负载附加到网址(例如，一些字符串化字符串和 urlencoded JSON)
3. 将URL发送给用户
4. 让用户在附件上签名 PowerForm的模板
5. 在我的webhook上接收回调
6. 以某种方式恢复自定义有效载荷

1. GET a PowerForm to obtain its URL
2. Attach a custom payload to the URL (e.g., some stringified and urlencoded JSON)
3. Send the URL to a user
4. Have the user sign the documents attached to the PowerForm's template
5. Receive the callback on my webhook
6. Recover the custom payload somehow

上下文是这样的:我想向特定用户发送文档进行签名，然后他们签名-识别他们的特定通知.这将是通过SMS或Skype(聊天机器人)进行聊天的一部分-因此返回URL并不是一个很好的选择.

The context is this: I want to send a specific user a document to sign and when they do it - recognize their specific notification. And this would be a part of a chat over SMS or Skype (chatbot) - so return URL is not really a good option.

我一直在寻找Template Custom Fields API的方向，因为实际上您可以使用URL来填充它们.但是看来，自定义字段在签名时必须在文档上可见，这带来了一个问题-对于最终用户来说，使用dfd84fc1-317f-4939-9dfb-4350d2127d2f(甚至带星号")之类的东西对UX来说是不好的.

I was looking in the direction of Template Custom Fields API because you can in fact fill them using the URL. But it looks like custom fields have to be visible on the document while it is signed and it poses a problem - having something like dfd84fc1-317f-4939-9dfb-4350d2127d2f (even "asterisked") would be a bad UX for the end user.

这是我第一次使用DocuSign API，所以我希望这只是我在基本概念中缺少的东西.因此，我要发布此问题.

It's the first time I'm working with DocuSign APIs and so I hope it's just my missing something in the basic concepts... Hence I'm posting this question.

推荐答案

您可以使用模板自定义字段，其文本颜色为白色以匹配背景.文本仍将刻录"到文档中(可通过ctrl-f查找)，但对签名者而言不会出现.

You can use a Template Custom Field with the text colored white to match the background. The text will still be 'burned in' to the document (findable via ctrl-f), but it won't appear to the signer.

或者，您可以使用信封自定义字段-签名者不可见这些字段，它们不会刻录到文档中，而是保留为可通过API访问的元数据".每个 https://docs.docusign.com/DocuSignHelp/Content/populate -custom-fields.htm :

Alternatively, you can use an Envelope Custom Field - these are not visible to the signer, they don't burn in to the document, but they are retained as 'metadata' accessible via the API. Per https://docs.docusign.com/DocuSignHelp/Content/populate-custom-fields.htm:

Envelope Field: To populate an envelope field in the Web PowerForm, add the following text in the URL:
EnvelopeField_<EnvelopeFieldName>=<value>
Where <EnvelopeFieldName> is the name of the envelope field in the Web PowerForm and the <value> is the value you want in the field.
Example: EnvelopeField_Region=Northwest

您可以通过致电

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

按照 https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/list

信封自定义字段也包含在Connect发布中

Envelope Custom Fields are also included in a Connect publish

这篇关于DocuSign:是否可以通过PowerForm链接发送自定义有效负载并通过webhook取回?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！