Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring a signature request to DocuSign

Updated on April 6, 2022

Improve customer experience, speed up case processing, and save money by implementing the DocuSign eSignature services as part of your case type definition.

You request digital signatures from Pega Platform through a dedicated Send via DocuSign V2 SmartShape. At run time, the SmartShape performs performs a series of activities, in the following order:

  1. Collecting the documents attached to the case.
  2. Packaging the documents in an envelope.
  3. Distributing the envelope to all recipients by using the DocuSign eSignature API.

Send via DocuSign V2 is a flow-based SmartShape that enables both basic and OAuth 2.0 authentication methods and supports such dynamic behavior like prompting the sender to acquire the OAuth 2.0 token during case processing, if not already acquired.

In addition, the smartshape facilitates status tracking for your envelopes by publishing entries in the case audit trail as the envelope advances through its life cycle. The following figure shows a sample set of event notifications that are related to DocuSign envelopes:

Envelope audit trail in a case type
The case type Audit tab that includes DocuSign envelope status changes.
For more information, see Configuring your DocuSign account to send event notifications and Preparing a DocuSign envelope.
Before you begin:
  1. Connect your application to DocuSign by installing the DocuSign component, and then configure the preferred authentication method for your API requests. For more information, see Connecting your application to DocuSign.
  2. Customize a DocuSign eSignature API request to create an envelope by adjusting the main pyPrepareNewEnvelope data transform and other associated data transforms to your business needs. For more information, see Configuring DocuSign envelopes.
  1. Find and open the case type that you want to integrate with the DocuSign services or create a new case type.
    For more information, see Creating a top-level case type.
  2. On the case type Workflow tab, in the stage that represents a point in the case life cycle in which you need to obtain a digital signature, click STEP.
  3. From the context menu, select MoreAutomationsSend via DocuSign V2.
  4. Optional: To change the SmartShape name, in the text box, edit the default value.
  5. Drag the SmartShape to the intended location within the stage.
  6. In the Step pane, in the Envelope Page Name field, specify the top-level data page that provides the payload for DocuSign eSignature API requests:
    • To invoke the pyPrepareNewEnvelope data transform and create a default page to capture the payload, leave the Envelope page name field is empty.
    • To skip invoking the pyPrepareNewEnvelope data transform and use an existing page as the payload source, enter the page name in the Envelope Page Name field.
    • To invoke the pyPrepareNewEnvelope data transform and create a new page with a custom name to capture the payload, enter the name of the new page in the Envelope Page Name field.
    For example: The following figure demonstrates a sample case type configured for obtaining digital signatures through the DocuSign eSignature API:
    Case type integrated with DocuSign services
    Case type Workflow tab with a stage that contains the Send via DocuSign V2 SmartShape
  7. Confirm your settings by clicking Save.
  • Previous topic Configuring advanced identity verification for envelope recipients
  • Next topic Additional configuration options for DocuSign integrations

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us