DocuSign to Avianis Integration Setup Guide

⚠️ Note: This integration does not rely on a shared DocuSign account provided by Avianis. Each customer must create and configure their own DocuSign developer account and provide the necessary credentials.

---

1. Pre-Requisites

• Ensure the DocuSign module is enabled for your organization in Avianis.

• You’ll need an active DocuSign Developer account. You can create one here: https://developers.docusign.com

---

2. DocuSign Developer Setup

Step 1: Create a DocuSign Application

1. In your DocuSign developer account, go to Integrations > Apps and Keys.

2. Click "Add App and Integration Key".

3. Save the Integration Key that is generated.

Step 2: Generate a Secret Key

1. Click on your new App.

2. Under Authentication, generate a Secret Key.

3. Save this key somewhere secure—you’ll need it in Avianis later.

Step 3: Add a Redirect URI

1. In the same application settings, add a Redirect URI:
   {your-avianis-instance}/docusign

2. Save your changes.

---

3. Configure DocuSign Connect (Webhooks)

Step 1: Add a Custom Connect Configuration

1. Navigate to Integrations > Connect in your DocuSign developer account.

2. Click “Add Configuration” and choose “Custom”.

Step 2: Enter Webhook URL

• Provide the function webhook URL (supplied by Avianis DevOps).
  This URL is the same for all customers in the same environment (Staging | Production).

Step 3: Enable Trigger Events

Under "Envelope and Recipients", configure the following:

• Enable relevant trigger events (e.g., Sent, Delivered, Completed).

• Under "Include Data", include necessary envelope details and custom fields.

💡 We use Custom Fields to pass CompanyGuidID, which is critical for identifying which organization the webhook relates to.

3. Click "Add Configuration" to save.

---

4. Connect DocuSign to Avianis

Step 1: Navigate to the Integration Page

1. Log into your Avianis instance.

2. Go to the Integration Settings page.

3. Locate the DocuSign Integration section.

Step 2: Enter Credentials

• Paste in your previously saved:

  • Integration Key

  • Client Secret

Step 3: Save & Authorize

1. Click “Save & Authorize”.

2. You’ll be redirected to DocuSign.

3. Log in and grant consent.

The account you use here is the one that Avianis will impersonate for all document signing operations.

---

5. Testing & Production Notes

• Initially, your DocuSign application is in sandbox mode.

• You must complete at least 20 API calls before requesting production access from DocuSign.

• Once approved, switch the webhook and redirect URLs to point to your production Avianis instance.

---

Technical Details & Best Practices

Token Management

• After initial authorization, our system configures and stores a refresh token.

• Tokens are auto-renewed by our system every ~20 days.

The refresh token is stored in the ModuleXML field of the OrganizationModule table in the application database.

Webhook Behavior

• DocuSign may send multiple webhook calls per event.

• Each signing action (e.g., sent, signed) creates a new entry in ESignatureDocument in the DB.

• Entries are grouped by EnvelopeID.

Drafted is an internal status indicating the signing process has started in Avianis but has not yet been handed off to DocuSign (no EnvelopeID yet).

Account Limitations

• Avianis can only impersonate one DocuSign account per organization.

• If that account is deleted or becomes inactive, the integration will fail until re-authorized with a different account.

---

Important Notes

• Your redirect URI must match the domain of your Avianis environment. This ensures proper token exchange and prevents failed authentications.

• Avoid enabling multiple active Connect configurations in a single DocuSign account for both staging and production—DocuSign will send callbacks to both.