docusignapi - DocuSign - Document Download

Question

I'm trying to use DocuSign via Rest API and ran into a question. After a user signed document and is redirected to the URL that is specified on RecipientView (/accounts/{accountId}/envelopes/{envelopeId}/views/recipient), Considering both best and worst case scenarios, how long should we wait before we download the signed document?

I'm asking this question because we saw some issues with SigniX in the past where, after SigniX returning the control to redirectUrl, the signed document was not available to download. Even though this happened very little number of times which might be <1% of all requests, Every single document is $$ and cannot afford to lose it.

If answer to my question is Yes, Please provide a C# example on using webhook.

Thanks.

Answer 1

You can setup DocuSign WebHook aka Connect notifications at your account level or envelope level and automatically receive the Documents when an envelope is completed.

Here is a sample CreateEnvelope request to setup configuration for the connect notifications per envelope level. Look at eventNotification property. All you have to do is host a listener to which DocuSign can send messages.

{
"emailSubject": "Testing connect notification",
"status": "sent",

"eventNotification": {
    "url": "<Add your listener URL here>",
    "loggingEnabled": "true",
    "requireAcknowledgment": "true",
    "envelopeEvents": [
        {
            "envelopeEventStatusCode": "Completed"
        }
    ],
    "includeDocuments": "true"
},

"recipients": {
    "signers": [
        {
            "name": "john smith",
            "email": "johnsmith@acme.com",
            "recipientId": "1",
            "routingOrder": "1"
        }
    ]
},
"documents": [
    {
        "documentId": "1",
        "name": "Contract",
        "fileExtension": "contract",
        "documentBase64": "DQoNCg0KDQogICAgICAgICBEdW1teSBDb250cmFjdA=="
    }
 ]
}

Here are some useful links which help you to setup your connect listener

• WebHook c# recipe
• More Api Recipes

Blog Posts

• Webhooks: Don’t Poll Us, We’ll Call You!
• Adding Connect Webhooks to your Application
• Securing Your Connect Webhook Listener