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.
Related
Currently, I am having a schedule job which get all uncompleted envelope status from my system and check each envelope status update from docusign via docusign sdk (Envelope env = envelopesApi.getEnvelope(accountId, envelopeId)). The reason to use that api is there are different use cases for each envelope status.
But I see that polling api (EnvelopesInformation envelopes = envelopesApi.ListStatusChanges(accountId, options)) has limitation that not allowed to poll DocuSign more than once every 15 minutes. I don't use this api now.
So is there any problems/limitation for envelopesApi.getEnvelope(accountId, envelopeId))?
Thanks.
The getEnvelope() and the listStatusChanges() requests both have the same polling limitation in place, if you start calling either too much your API key might get throttled or temporarily disabled by DocuSign.
However, since the listStatusChanges() request returns status on a whole set of envelopes instead of just one envelope at a time this is the preferred API request when polling the DocuSign platform.
Furthermore, the truly optimal option which doesn't count at all against the platform limits is using DocuSign webhooks to push status out to your app instead of your app constantly polling. You can configure webhooks either through the DocuSign Connect module or by using eventNofications through the envelope structure.
Learn more about DocuSign Webhooks.
How to configure DocuSign API to send only notifications that pertain to the document not being viewed within 32 hours in my email/inbox?
Aside from 'This envelope is expiring soon', there are not built-in notifications that relate to inactivity on an envelope. You would have to build a custom solution that monitors envelope status via DocuSign Connect, and then delivers notifications as desired.
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.
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.
I am using DocuSign api for my client website portal as customer documents digital process. Everything works great except one feature needed.
I am creating dynamic document (with php) and sending to customer via DocuSign api to sign (using DocuSign digital signature setup).
And i have added 'check status' button in my website to check that specific document/envelope (by forwarding envelope unique id to DocuSign api get envelope status) and updating in my database and also downloading that signed document from docUsign.
Now i need the above process to be done automatically which means when the customer signs, a callback should trigger to my website url (like some webhook i need setup) and then i will check that envelop status and update my database.
Can any one give some suggestions or code snippet where i can keep that webhook url option to get auto response from DocuSign (just like paypal IPN)
Thanks in Advance
You can use DocuSign Connect to do exactly what you've described. Using DocuSign Connect, you can configure DocuSign to automatically push Envelope status and documents to an endpoint you specify when the Envelope event(s) you specify occur (for example, Recipient completes/submits an Envelope, or Envelope reaches status = completed, etc.).
DocuSign has published several code samples that show how to use DocuSign Connect. For example:
PHP and Python webhook sample
C# webhook sample
Node webhook sample
Java webhook sample
These samples (and others) can be found in the DocuSign GitHub org.