DocuSign retrieve envelope status

Nintex external platform is required for this feature. For details, see Enable Nintex external platform features.

Retrieves the status of an envelope in DocuSign. This action can be used to poll for sent envelopes while status is still "In Process."

What can I do with this workflow action? 

You can use this action as part of a workflow that sends forms to attendees in a list and then performs the appropriate business task according to the envelope status—either updating attendee status or deleting the attendee from the list.

Action settings

Following are the fields and options visible in the configuration settings dialog box for this action.

Field Description

Connection

Select a DocuSign connection.

For more information about connections, see Manage connections to external providers.

Older workflows created with manual authorization, such as those retained during upgrades, continue to require manual authorization. For these workflows, the following fields are available.

Authorizing user

Specify an email address for the authorization request. External email addresses can be used.

  1. On execution of the action, a message is sent to the email address specified for the authorizing user. The message contains the following details.

    From: notification@nintexlive.com

    Subject: Contains the phrases "Nintex" and "Request authorization"

    Contents: Contains links to authorize or deny the operation

  2. When the authorizing user clicks the link to authorize the operation, the authorizing user is prompted to do the following.
    • Log in to the external service

    • Allow Nintex to access the external service

    • Decide whether to waive future Nintex authorization requests for this external service

  3. When the prompted actions are completed, the action completes.

If the authorization process is not completed, then the workflow suspends. This situation can occur in the following scenarios.

  • The authorizing user explicitly denies the operation, either by clicking the deny link in the email message or not allowing Nintex access to the external service after logging in.

    Error logged for suspended workflow:

    “The service request has been denied.”

  • Seven days pass without completion of the authorization process. Either the authorizing user never clicks the authorize link in the email message or the authorizing user initiates the process but does not complete all steps. For example, the authorizing user logs in to the external service but does not allow Nintex to access the external service.

    Error logged for suspended workflow:

    “The service request has expired.”

Envelope ID

Specify the envelope ID.

Status is retrieved from the specified envelope ID.

Note: Envelope ID can be retrieved from the output of one of the following workflow actions: DocuSign send document or DocuSign populate template.

Output

Store output for this action using the following selections.

  • Status: Specify a text variable that will store the envelope status.

    • Draft: The envelope is in a draft state and has not been sent out for signing.
    • In Process: The envelope has been sent and is waiting for one or more recipients to complete their actions.
    • Completed: All recipients have completed the actions for the envelope.
    • Declined: A signer has declined to sign/complete the envelope.
    • Voided: The sender of the envelope has canceled an envelope or the envelope expired before the receiver took any action.
    • Template: The envelope is a template.

  • Message: Specify a text variable that will store the reason if the status is "Declined" or "Voided"; otherwise the value is empty.

    • Steve declined the envelope [Reason: <Declined Reason>]
    • The envelope has been voided and email notifications were sent [<Voided Reason>]

Depending on action requirements, you may be able to add and remove output variables.

To add an output variable

  1. Select an option from the Select more drop-down list.
  2. Click Add to display a drop-down list for the selected option.
  3. Select a previously defined workflow variable from the drop-down list.

To remove an output variable

  • Click Delete ().

    Note: Some output variables cannot be deleted. For example, the output variable URL for the action Bing news search cannot be deleted.