FINS DocuSign Experience API - Implementation Template

This API implementation template is a component of MuleSoft Accelerators, which accelerate the implementation of essential integration use cases.

The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.

---

Overview

This integration template implements the DocuSign Experience API specification. It can be used to capture events that have been triggered by DocuSign Webhook Connect. This event is then mapped to a canonical Document format and published to the fins-document-update-exchange.

Getting started

The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications.

Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.

Prerequisites

This implementation template has the following dependencies:

• An app and integration key configured in DocuSign
• Anypoint MQ Destinations

Please review the use cases described on the MuleSoft Accelerator for Financial Services solution pages for more information about dependencies on other APIs and services.

Anypoint MQ destinations

The following Anypoint MQ destinations must be created and accessible for this API:

1. fins-document-update-exchange

Configuring a webhook connect in DocuSign

These instructions assume a DocuSign account is created.

• Log in to your DocuSign account with Account Administrator rights
• Click on 'Settings'
• In the navigation pane on the left side of the page, find 'Connect'.
• Select 'Add Configuration' and pick 'Custom' as the type.
• Enter name for the configuration and the URL endpoint (this would be the callback url of the fins-docusign-exp-api i.e post:/documents).
• In the 'Event Settings' section, select 'Aggregate' option in 'Event Message Delivery Mode' section.
• In the 'Trigger events' section, click on 'Envelope Events'. Select the checkboxes 'Envelope Signed/Completed', 'Envelope Declined' and 'Envelope Voided'.
• In the 'Include Data' section, click on the checkbox 'Custom Fields' to receive the custom fields in the envelope.
• Click on "Add Configuration"

Deployment

Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).

For additional details, please refer to the Application Deployment section of the Getting Started Guide.

Preparation

Ensure the Maven profile CloudHub-FINS-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).

Required property overrides

At a minimum, the following properties must be customized for this application to reflect the target deployment environment.

Testing

Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a Postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.

Additional resources

• The Data mappings tab describes how the request and response data structures are mapped between the API interfaces.
• Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.