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.

When you execute this action in a workflow for the first time, Nintex for SharePoint 2016 will send an authorization email to users based on the unique connection from the Connection Manager and the action type from the DocuSign action. The second time that you execute this action in a workflow that uses the same unique identity combination, users won’t receive an authorization email, but the workflow will execute as designed. However, if users do not complete the authorization, they will continue to receive authorization emails when the workflow is executed.

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.

Note: Due to DocuSign's decommission of basic authentication, DocuSign connection tests in the Connection Manager will fail, even if all of the credentials are correct.

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.