File and Document Management

DocuSign

14min
with docusign modules in make, you can monitor and retrieve envelope status, search and retrieve envelopes, or download and send a document to sign in your docusign account to use docusign modules, you must have a docusign account you can create an account at go docusign com/o/trial https //go docusign com/o/trial/ refer to the docusign api documentation https //developers docusign com/docs/esign rest api/reference/ for a list of available endpoints connect docusign to make to make the connection in make log in to your make account, add a docusign module to your {{scenario singular lowercase}} , and click create a connection note if you add a module with an instant tag, click create a webhook , then create a connection optional in the connection name field, enter a name for the connection optional click show advanced settings and enter your docusign docid\ gsrahchjf7z17we 8yjon click save if prompted, authenticate your account and confirm access you have successfully established the connection you can now edit your {{scenario singular lowercase}} and add more docusign modules if your connection requires reauthorization at any point, follow the connection renewal steps here docid\ so88fm6pkt0g adkddfzz create a custom application in make to create the docusign custom application and retrieve your client credentials log in to your docusign account in the upper right, click settings in the left menu, under integrations , click apps and keys click add app and integration key under app name , click create app under general info , copy the integration key and store it in a safe place under authentication , click +add secret key and store it in a safe place under additional settings , for redirect uris , add https //www integromat com/oauth/cb/docusign click save you will use these values in the < integration key (client id) > and < client secret > fields in make envelope watch events triggers when an envelope changes its status this is available only for business pro docusign esignature pricing plan https //www docusign com/products and pricing and higher the webhook url needs to be generated in make and then added to docusign's integrations settings add the watch events module to your make {{scenario singular lowercase}} generate and copy the webhook url log in to your docusign account go to settings > connect click add configuration , and select custom fill in the fields as follows name enter the name of the webhook url to publish enter the webhook url you have copied in step 2 above include select the information that you want to include in the webhook trigger events select events that will trigger the webhook and the watch events module in your make scenario click the add button to save and close the dialog now, every time the specified events occur in your docusign account, the watch events module in your make {{scenario singular lowercase}} is triggered note the module returns the data in the xml format to further process the returned data, please add the xml>parse xml module after the watch events module search envelopes searches for envelopes by the filter settings connection docusign docid\ gsrahchjf7z17we 8yjon account select the account you want to search for envelopes from date enter the date and time to start looking for status changes to date enter the date and time to stop looking for status changes envelope ids add the envelope ids to filter returned envelopes by transaction ids add the envelope transaction ids to filter returned envelopes by transaction ids are only valid for seven days status select the envelope statuses you want to be included in the result from to status select the envelope status that you are checking for for example, if you select changed , the module returns a list of envelopes that changed status during the from date to to date time period search enter the search term you want to use to filter the list of returned envelopes order select whether you want to return envelopes in ascending or descending order order by select the property you want to sort returned envelopes by limit set the maximum number of envelopes make will return during one execution cycle user filter returns envelopes where the authenticated user is the recipient, the sender, or the recipient only include in response select additional information to return about the envelopes custom fields the custom fields associated with the envelope documents the documents associated with the envelope attachments the attachments associated with the envelope extensions information about the email settings associated with the envelope folders the folders where the envelope exists recipients the recipients associated with the envelope powerform the powerforms associated with the envelope payment tabs the payment tabs associated with the envelope get an envelope status retrieves envelope details connection docusign docid\ gsrahchjf7z17we 8yjon account select the account that contains the envelope you want to retrieve details about envelope id enter (map) the id of the envelope you want to retrieve details about include in response select additional information to return about the envelopes custom fields the custom fields associated with the envelope documents the documents associated with the envelope attachments the attachments associated with the envelope extensions information about the email settings associated with the envelope folders the folders where the envelope exists recipients the recipients associated with the envelope powerform the powerforms associated with the envelope tabs the tabs associated with the envelope payment tabs the payment tabs associated with the envelope download a document downloads a specified document from the envelope connection docusign docid\ gsrahchjf7z17we 8yjon account select the account you want to download a document from envelope id enter (map) the id or select the envelope that contains the document you want to download document id enter (map) the id or select the document you want to download certificate select the no option to exclude the envelope signing certificate from the download documents by user id when the yes option is selected, it allows the recipients to get documents by their user id for example, if a user is included in two different routing orders with different visibilities, using this option returns all of the documents from both routings encrypt when enabled, the pdf bytes returned in response are encrypted for all the key managers configured on your docusign account show changes when set to yes , any changed fields for the returned pdf are highlighted in yellow, and optional signatures or initials are outlined in red watermark when set to yes , the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is then added to the pdf documents this option can remove the watermark language select the language of the certificate of completion in the output get envelope form data downloads the envelope and field data from any in progress, completed, or canceled envelope that you sent or that is shared with you to use this module, go to docusign settings > sending settings and enable the allow sender to download form data option otherwise, the \[400] this user lacks sufficient permissions error will be returned connection docusign docid\ gsrahchjf7z17we 8yjon account select the account that contains the envelope you want to retrieve the form data from envelope id enter (map) the id of the envelope you want to retrieve the form data from send a document to sign sends a document to signers connection docusign docid\ gsrahchjf7z17we 8yjon account select the account that contains the envelope with the document you want to send in order to be signed draft enable this option to save the envelope as a draft if disabled, the envelope will be sent to recipients signers add the signers you want to send the document to email enter the recipient's email address the system sends notifications about the documents to be signed to this address name enter the full legal name of the recipient maximum length 100 characters recipient id enter the id you want to assign to the recipient recipient id is a local reference that senders use to map recipients to other objects, such as specific document tabs within an envelope, each recipient id must be unique, but there is no uniqueness requirement across envelopes for example, many envelopes assign the first recipient a recipient id of 1 add access code enable this option, and enter the code if you enter a value, the recipient must enter the value as the access code to view and sign the envelope maximum length 50 characters, and it must conform to the account's access code format setting if blank, but the signer access code property is set in the envelope, then that value is used if blank, and the signer access code property is not set, then the access code is not required note enter a note that is sent to the recipient in the signing email this note is unique to this recipient in the user interface, it appears near the upper left corner of the document on the signing screen maximum length 1000 characters subject enter the subject of the email used to send the envelope message enter the content of the email blurb documents add documents you want to send source file map the file you want to upload from the previous module (e g , http > get a file or google drive > download a file ), or enter the file name and file data manually document id specify a numeric id that must be unique within the envelope send a document from template to sign creates and sends an envelope from a template connection docusign docid\ gsrahchjf7z17we 8yjon account select the account that contains the envelope with the document template you want to send in order to be signed template enter (map) or select the template you want to send a document from draft enable this option to save the envelope as a draft if disabled, the envelope will be sent to recipients subject enter the subject of the email used to send the envelope message enter the content of the email blurb template recipients add the signers of the document email enter the recipient's email address the system sends notifications about the documents to be signed to this address name enter the full legal name of the recipient maximum length 100 characters role name enter the role of the signer for more details about templates please refer to the docusign's templates article other make an api call allows you to perform a custom api call connection docusign docid\ gsrahchjf7z17we 8yjon account select the account you want to make an api call for url enter a path relative to https //\<server> docusign net/restapi if you use {accountid} in the path, it will be replaced with the account id from the selected account automatically for example /v1/org note enter a path relative to https //\<server> docusign net/restapi if you use {accountid} in the path, it will be replaced with the account id from the selected account automatically method select the http method you want to use get to retrieve information for an entry post to create a new entry put to update/replace an existing entry patch to make a partial entry update delete to delete an entry headers enter the desired request headers you don't have to add authorization headers; we've already done that for you query string enter the request query string body enter the body content for your api call example of use list envelopes the following api call returns envelopes from the specified date in your docusign account url /v2 1/accounts/{accountid}/envelopes/ method get query string key from date value yyyy mm dd specifies when the request begins checking for status changes for envelopes in the account the result can be found in the module's output under bundle > body > envelopes in our example, 6 envelopes were returned