0
votes

Is there a way that I can provide any custom document metadata when adding documents to my DocuSign envelopes when using the REST API?

DocuSign appear to enforce the use of a positive integer for the DocumentId's we provide in the envelope. Whilst we are indeed using a positive integer, sometimes, there is some additional info that we need to supply, which we would like to come back in the DocuSign webhook events for specific documents.

I've had a look at the Document object but can't see anything obvious that I could use. An example would be simply providing a true/false along with a specific document, which I can inspect when I receive the DS webhook events.

At the moment, the only workaround I can think of is to add an Envelope Custom Field which contains any of my DocumentId's where 'true' is applicable, which feels like a bit of a shoddy solution, and I don't know if there's a character limit in those Envelope Custom Fields, which could break such a workaround.

1

1 Answers

0
votes

Custom envelope text fields give you complete flexibility on providing meta-data that you can get back from the webhook. Here is some information about this:

This is how you create a custom field for an envelope:

https://developers.docusign.com/docs/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create/

This article shows code examples in 7 languagues on how to get the custom fields values : https://developers.docusign.com/docs/esign-rest-api/how-to/get-envelope-custom-field-values/