I've already been successfully using the envelope eventNotification webhooks to receive status updates for various envelope and signer events (Sent, Delivered, Completed, etc.), but I'm trying to solve one last event case: adding and removing signers from the envelope.
Suppose in a situation where envelopes are shared among multiple people in a company:
1. Someone creates an envelope through the API, and adds 3 signers.
2. Someone else makes corrections to the envelope using DocuSign's web site, and removes a signer...
Is there any way for my app to know that action #2 took place? Or do I have to wait for one of the regular signer events to take place before I will know that the signers on the envelope have changed?
Connect event triggers for the start and finish of Envelope Correct are a good idea. You'd use the finish trigger to figure out what has happened.
This enhancement request is internally logged at DocuSign as CONNECT-510.
Ask your DocuSign Account Executive or Account Manager to add your organization's interest in the enhancement. It is not yet scheduled to be released, other Connect architectural work is needed first.
The history of the envelope, including correct operations is available from Envelopes: listAuditEvents. You could use that today to see if someone is correcting the envelopes you're interested in.
Related
In certain circumstances we would like to automate the forwarding of completed Docusign contracts to certain new recipients, possibly adding another page. Is there a way to do that with the REST API, or does that have to be done manually?
The short answer is Yes.
In DocuSign-speak, "completed" means that the envelope (transaction) has reached its final stage. No more changes, it's frozen and saved in the DocuSign platform.
Also, note that virtually anything you can do via the DocuSign web app can also be done programmatically via one of DocuSign's APIs.
So you have two options:
Send the first envelope to someone else as a new envelope
After the first envelope is complete, your API program could analyse it to see if it needs some additional recipients. If so, your API program could start a new envelope transaction that includes the completed (signed) document, possibly the first envelope's certificate of completion, along with the new documents to be signed (or not) and new recipients.
You could include the first set of documents (from the first envelope) either as supplemental documents to the new envelope or as regular documents within the new envelope. To obtain the documents from the first envelope, your application would download them from DocuSign and then upload them for the new envelope.
A live "supplemental" documents example.
A envelope is optionally sent to additional recipients
An alternative is to have one envelope and optionally programmatically send it to additional signers with, perhaps, additional documents for the new signers.
This might be a bit trickier to program with the DocuSign eSign APIs but is certainly doable.
After the last "original" signer has completed signing, you can pause the workflow.
Once the workflow is paused, your application can again analyse the document to see if more recipients need to sign, an additional document needs to be added, etc. Then your API program uses the API to update the envelope as needed, including adding additional recipients (who may or may not be signers). This is called "correcting" the envelope. Then your program resumes the envelope's workflow.
Your program should be notified that the envelope has paused by using the Connect webhook feature, either at the account or envelope level.
If you have more questions about this answer, please open new questions on StackOverflow. Make each question as specific as you can. Thank you.
I am using Remote Signing with the DocuSign api, but I want to know how to determine what action the recipient took (i.e. they signed, declined to sign, viewed, etc). How do I do this?
You want the status of the envelopes you sent?
Best technique is to create a webhook and have DocuSign call your server when the envelope's status changes.
You can create DocuSign notification message subscriptions at either the account level or at the individual envelope level.
See this blog entry for more info. Ask additional questions on StackOverflow if you have any difficulties.
Currently in our application user has to accept one envelope at a time to acknowledge. can we merge or make Docu Sign work space functionality to acknowledge more than one envelopes at a time.
So that user can select multiple envelopes and on acknowledging once all envelopes should get acknowledged.
There is no way you can acknowledge more than one envelope at one time (or in single click). But you can have a concept of Workspace in DocuSign, which means you will be taken to a place/screen where you will see all the envelopes which you need to take action on. And from that screen, acknowledge all the envelope and no need to search each and every emails for this. Check DocuSign Workspaces for more details
Once any document is sent for signature, we can see that document status like in process, completed. Also email notification is coming to document sender mail. Are these features exposed by docusign rest API?
Yes, absolutely. The status updates are delivered to your program via a "webhook" -- you register a url with DocuSign and then DocuSign calls your app when a change occurs.
You can create a webhook subscription at the account level or for individual envelopes.
See the docs. Recipes are also available at the DocuSign Developer Center.
Added
You can also determine the current status of your signing requests (your envelopes) by polling the DocuSign platform. However, this is actively discouraged, and in any case, you can't poll more than once per 15 minutes for a given envelope. The docs discuss this as well.
There is a documentation about possible envelop status value from docusign for a given envelope.
Howver i am trying to understand if there are any documentation which lists out the possible "Action" value from docusign in the "Audit_event" REST API method.
The reaosn is I am storing the audit events locally to avoid multiple API calls and i wanted to account for all the possible action values.
Thanks for reading
Since there were any documentation provided, i am including the staus i have seen based on my reverse engg
Registered
Sent Invitations
Printable Copy Delivered
Printable Copy Attached to Email
AccessCode Passed
AccessCode Failed
Viewed
Signed
Approved
Resent
Voided
Declined
Correction Initiated
Correction Cancelled
Viewed In-Session
Corrected
I've never seen any documentation for possible values of the action property within a GET Envelope Audit Events response -- to the best of my knowledge, none exists. You might be stuck having to 'reverse engineer' to determine possible values. i.e., create envelopes via the DocuSign web console, act on them in a variety of ways (both as Sender and as Recipient) -- for example: Send Envelope, Void Envelope, Decline Envelope, Sign Envelope, View Envelope, Pass Signer Authentication, Fail Signer Authentication, etc. etc. etc. -- and then examine the corresponding action values that appear in the GET Envelope Audit Events response for those Envelopes.
Obviously this approach is not ideal, since someone fairly new to DocuSign won't necessarily know all of things that can be done with an Envelope, in order to trigger the various action values in the API response. Perhaps someone from DocuSign will see this post and chime in with a list of all possible values...or better yet, add this info to the API Guide one day soon.