DocuSign
Introduction
To enable Cyclr to use the Docusign API, you need to create an Application within Docusign as described below.
Setup & Authentication
Overview
Cyclr Partner setup:
Create an Application within Docusign.
Store your Docusign Integration Key and Secret Key in your Cyclr Partner Console.
Remote Setup in Docusign - performed by Cyclr Partner
A Cyclr Partner only has to create a single Docusign Application.
Your customers don’t need their own separate Applications within Docusign.
Login to your Docusign Portal.
Go to Settings > Integrations > Apps and Keys.
Select the ADD APP AND INTEGRATION KEY button.
Enter a name for your app.
Select Authorization Code Grant.
Add a secret key and copy this for later.
Add a Redirect URI that points back to the Callback URL of your Cyclr Partner Console, which is in this format:
https://{Your Cyclr Service Domain}/connector/callbackEnter a link to your privacy policy.
Save the application.
You need the integration key to set up the Connector in Cyclr.
Partner Setup in Cyclr Console
Having created an Application within Docusign to obtain an Integration Key and a Secret Key, go into your Cyclr Partner Console:
Go to Connectors > Application Connector Library.
Use the search box to find the DocuSign Connector entry.
Select the Pencil button.
Select the Settings tab.
Enter the below values:
Property | Description |
|---|---|
Client ID | The Docusign Integration Key. |
Client Secret | The Docusign Secret Key. |
Scopes | You can leave this blank or you can reduce the scopes Cyclr requests when the Connector is installed, based on the methods you require in your integrations. This field is a space-separated list of scope values. A full list of scopes is available here. |
Select Save Changes.
If you leave these values blank, they must be provided each time the Connector is installed.
Account setup
Additional to any values you leave blank when you set up the Connector, Cyclr also asks for the Domain when you install the Connector into an Account.
You can select the appropriate Domain using a dropdown:
The Sandbox Domain is
account-d.docusign.com.The Production Domain is
account.docusign.com.
Additional Setup
Webhook Setup
Cyclr uses the “Docusign Connect” service to implement Webhooks.
To set up a Webhook within Cyclr, after installing a DocuSign Connector:
Go into the Cyclr Builder.
Expand the DocuSign Connector under Application Connectors on the right of the Builder.
Expand the “Connect (Webhook)” Method Category.
Drag in one of the Methods you wish to use.
Select the new Step’s Step Setup button.
Provide values for the required fields:
Field | Description |
|---|---|
Events | A comma-separated list of Docusign event types to receive. For example: |
Enable Log | Set to Docusign has a maximum of 100 events that can be shown on its “Audit Logs” page. |
User IDs | A comma-separated list of user IDs. This is only required when using “Connect (Webhooks)” Methods that have “specified users” in their name, for example: |
Cyclr automatically creates entries within Docusign Connect relating to its Webhooks when a Cycle is first started that uses a relevant Connector Method.
Those entries are automatically deleted when either the Webhook Step or the Cycle containing it is deleted.
All Docusign Connect Configurations are named "Automated API Integration ({Unique ID})".
Docusign has a limit of 20 Custom Connect Configurations per Docusign account.