Configuring an alternative way to get an Envelope ID

This page describes an alternative approach for customers that use the Callback method to get the Envelope ID from the form viewer.

By default, all Quik! HTML forms now include a hidden field which, once the Send button is clicked in the e-sign pop-up, is populated with the newly created DocuSign Envelope ID. Customers can then retrieve the Envelope ID with a custom function contained within the ESignVendorSuccessJavaScript property. In addition, now, when any value is provided for the ESignVendorSuccessJavaScript property, all alert messages that are typically shown upon a successful Callback event are hidden. If customers still want to show an alert message, they will need to include a custom one within their ESignVendorSuccessJavaScript function.

Sample code shown below for skipping the E-Sign Pop-up, generating a form in draft mode, and getting the Envelope ID using a function in the ESignVendorSuccessJavaScript property. Note that this function is posting the Envelope ID to the user’s console log. This part should be replaced with whatever location the customer desires to post the Envelope ID. This function uses jQuery, but JS can be used instead if need be.

REST JSON

{
  "HostFormOnQuik": true,
  "QuikFormID": "12",
  "ESignType": {
    "Type":"DocuSign",
    "CreateEnvelopeAsDraft": true,
    "SkipESignPopup": true,
    "AuthUserID":"<your AuthUserID>",
    "SignCallBackURL":"<your SignCallBackURL>",
    "SignEnvironmentID":<your SignEnvironmentID>,
    "ESignVendorSuccessJavaScript": "function(){var id = $('#ESignTransactionID').val(); console.log('done signing!. EnvelopeID is ' + id);}",
  }
}

Quik! API Guide

Configuring an alternative way to get an Envelope ID

Related pages