For webhook event notifications, the completed event in particular, will the delivered and signed dates always be in PST or will they vary based on the server the user's base url points at or their account? I don't see that mentioned anywhere in documentation and it's impossible to tell from a demo account.
Of note:
1) We are not using Connect, just redirect url(s) on our integrator key that are added to envelope definition's envelope notification properties.
2) We are supporting multiple clients, each with their own DocuSign account.
The dates in the event notification will be in the Timezone that is set in your account settings. This will be applicable to all the envelopes sent from your account.
You can go to the Docusign Admin page and manage your account settings.
See this answer for more information.
EDIT:
You can set the property includeTimeZone in your eventNotification. The envelope’s time zone information will then be included in the webhook messages.
Related
I am an admin account user and to get insights from data I need to pull the details of all the envelopes from all accounts. The similar thing is what a report provides in Docusign dashboard but I need the list of recipients as well. Can anyone please help me. Thanks.
Listing envelopes sent by your users: Envelopes::listStatusChanges
I think that call may cover envelopes sent by anyone in your account (if the accessToken represents a user with admin privileges). But I'm not sure.
If it doesn't then you can loop through the account's users.
Tracking who has received an envelope through their DocuSign account is done with the Folders::listItems API call. You may need to list both the Inbox and Deleted folders. You also need to check that the person signed the specific envelope vs receiving it for some other reason (cc, certified copy, etc).
Finally, an alternative if you have higher volumes is to purchase the DocuSign Report Feed product (see note below). It will send you DB table dumps about your account activity on a regular basis so you can do your own reporting on DocuSign activity. It is the best way to have full access to report data. Ask your DocuSign contact for more info.
Note: I'm not sure of the exact name for the reporting product.
This can be done if you install DocuSign for Salesforce managed package and use Connect feature in DocuSign. Configure your webhooks to create DocuSign Status and DocuSign Recipient Status records for each send. Any DocuSign objects or custom object can be used in the Connect configuration, after selecting objects, select which events you want the results to be pushed back to Salesforce.
Use a parent object to store envelope details and child object for the recipient data. Use Envelope Id to relate the child records to the parent. Eventually, you will be able to build various reports on Salesforce.
More info here: https://support.docusign.com/guides/dfs-admin-guide-ds-connect-for-salesforce
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.
createSender creates a URL, which I would like to use to let the sender preview the document before it's send out. Hence the documents are created using templates and and the API.
The link which is created would lead me out of my UI. Does the user need to sign in? Future plan is to have many user's, which have no DocuSign account.
For embedded sending Your app will have to authenticate the user. If you are doing a Service Integration then your Api account will be used as the sender.
Once the sending url is generated using the createSenderView api, there is no authentication required to access the URL.
You also have an option to build a User Application using the docusign Api where your App can support sending from multiple accounts.
The createSenderView requires that the person is a DocuSign user (with their own account and password).
Only DocuSign users can send. We charge for sending, not for signing or receiving.
What exactly do you want to preview? (And why?)
the documents themselves? Use the EnvelopeDocuments resource. You can also preview the thumbnails of the documents.
the documents with the "fields" ("tabs") that indicate where people will sign? I'm not sure that is do-able.
or the recipients and their routing order? Use EnvelopeRecipients: list method.
Added
Another solution is to use a dummy certified delivery "recipient". Add this recipient as the first recipient. This will block the envelope from proceeding on the recipient routing.
Then get the envelope's documents to show as a preview.
Then, if ok, alter the envelope's recipients to remove the certified delivery recipient. The envelope will then continue on with the first "real" recipient.
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.
I have been creating DocuSign envelopes using SOAP based API call "CreateAndSendEnvelope".
When I create an envelope using captive recipients into my DocuSign demo account..
1) When I include captive recipient's e-mail address in the SOAP request, would a captive recipient get a signed document back? I am not able to get the signed document back. I get an email with the notification that I signed the document.
2) My session never times out. According to DocuSign documentation, the session times out in 5 minutes and it is a configurable setting. Where should I look at that setting and how should I test the session timeout?
3) When I request recipient token once and if I make the request to get the token within a short period of time, I get an error. After I wait for a few minutes, I am able to retrieve the recipient token fine. Is there a time frame that I should consider while making a request to retrieve the recipient token?
1) You can control whether or not to include the completed documents in the email through an account setting. Login to the Console and go to Preferences -> Features, and on that screen you should see an option labeled "Attached Documents to Completed Envelope Email".
2) The default session timeout is actually 20 minutes, not 5. And if you want to change that you need to contact your Account Manager - it's not a setting you have direct access to.
3) Embedded Sending and Signing URL tokens are only valid for 5 minutes, after which they expire. At that point you simply need to generate a new URL token for the given recipient.