Skip to main content

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

Configuring your DocuSign account to send event notifications

Updated on April 6, 2022

Configure your DocuSign account to send notification messages to your application in response to events that represent various stages of the envelope life cycle.

For example, when all recipients sign their documents in an envelope and the signing process is complete, you can get the documents back from DocuSign for further processing in your application.

By default, Pega Platform supports notifications only for the Document Completed envelope event type. However, you can configure your application to receive notifications for additional envelope or recipient event types, as needed.

Note: By configuring event notification settings on the account level, you ensure that the settings are the same across all case types in your application. If your business objectives require various sets of event notification settings depending on the case type, you can instead configure event notification settings in the pyPrepareNewEnvelope data transform. For more information, see Preparing a DocuSign envelope.
Before you begin: Enable DocuSign Connect for your account. For more information, see the following article in the DocuSign Developer documentation: DocuSign Connect overview.

    Enabling notifications in the DocuSign Developers portal

  1. Sign in to your DocuSign account.
  2. In the DocuSign Connect Edit Custom Configuration pane, configure the notification settings:
    1. In the Listener Settings section, in the URL to Publish field, enter the address of the pyConnect REST service in the following format:
      https://<Your domain>/prweb/PRRestService/DocuSignService/Services/pyConnect
    2. In the Event Settings section, in the Envelope and Recipients list, select the event types to trigger notifications in your application.
    3. In the Include Data list, select the data items to include in each notification.
    For more information, see the following aricle in the DocuSign Developer documentation: Webhook event triggers.
    For example: The following figure provides a sample notifications configuration:
    Configuring notification settings for a DocuSign account
    Custom configuration for notifications in the DocuSign Developer portal.
  3. Save your configuration.
  4. Enabling event notifications in your application

    Note: The pyProcessDocuSignEvents activity contains placeholder activities that you can use to define a processing logic for recipient and envelope events to which you subscribed by configuring DocuSign Connect. Pega Platform comes with a default activity configuration for the Document Completed event type.
  5. In your Pega application, find and open the pyProcessDocuSignEvents activity.
  6. Save the pyProcessDocuSignEvents activity as part of your application ruleset.
  7. On the Steps tab, in the Method column, click the Open icon to open the activity that corresponds to the event type that you want to enable.
    For example: The pyProcessDocumentDeclinedEvent activity for the Document Declined event type.
  8. Save the activity as part of your application ruleset.
  9. In the activity, implement the logic for processing the event type in your application.
    Tip: You can use the default implementation for the Document Completed event type as reference.
    The following figure shows the pyProcessDocuSignEvents activity and an empty placeholder activity that you can adjust to your business needs:
    Adjusting the pyProcessDocuSignEvents activity to process additional event types
    The pyProcessDocuSignEvents activity rule form and an empty placeholder activity for processing declined envelopes.
  10. Confirm your settings by clicking Save.
  11. Repeat steps 6 through 9 to configure additional event notifications.

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