How to use IBM® App Connect with DocuSign
DocuSign is an electronic signature and document approval software that allows you to send, sign, and manage agreements across multiple devices.
- App Connect Enterprise as a Service connector
-
Local
connector in containers (Continuous Delivery release) 12.0.7.0-r1 or later -
Local connector in containers (Long Term Support Cycle-2 release)
Connecting to DocuSign
Complete the connection fields that you see in the App Connect Designer page (previously the Catalog page) or flow editor. If necessary, work with your DocuSign administrator to obtain these values.
- Provide credentials for App Connect to use (API KEY) - App Connect in containers and App Connect Enterprise as a Service
- Provide credentials for App Connect to use (BASIC OAUTH) - App Connect in containers and App Connect Enterprise as a Service
- Use the application's website to sign in (OAUTH 2.0 AUTH CODE) - App Connect Enterprise as a Service
| Provide credentials for App Connect to use (API KEY) | Provide credentials for App Connect to use (BASIC OAUTH) | Use the application's website to sign in (OAUTH 2.0 AUTH CODE) |
|---|---|---|
| Endpoint URL | Endpoint URL | Endpoint URL Tip: Authorize connection to DocuSign by signing in to your account.
|
| Integration key | Client ID | |
| User ID | Client secret | |
| RSA private key | Access token | |
| Refresh token |
| Connection field | Description |
|---|---|
| Endpoint URL | For the developer environment, the endpoint URL is: account-d.docusign.com. For the production platform, the endpoint URL is: account.docusign.com. |
| Integration key | The integration key to identify your application to DocuSign for communicating with DocuSign APIs. |
| User ID | The user ID to access your DocuSign account. |
| RSA private key | The RSA private key used to encrypt your token in the JSON Web Token (JWT) authentication flow. |
| Client ID | The consumer key that is generated when you create a connected app for App Connect in DocuSign. |
| Client secret | The consumer secret that is generated when you create a connected app for App Connect in DocuSign. |
| Access token | The access token generated from the application client ID and client secret. |
| Refresh token | The refresh token generated from the application client ID and client secret. |
To obtain the connection values (Integration key, RSA private key, Client ID, Client secret, Access token, and Refresh token) for DocuSign, see Obtaining connection values for DocuSign.
To connect to a DocuSign endpoint from the App Connect Designer Applications and APIs page for the first time, expand DocuSign, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with DocuSign, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
DocuSign events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
DocuSign actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Attachments | Create attachment | Creates an attachment in DocuSign |
| Delete attachment | Deletes one or more attachments from a draft envelope | |
| Retrieve attachments | Returns a list of attachments associated with a specified envelope | |
| Update attachment | Updates an attachment to a draft or an in-process envelope | |
| Documents | Bulk create or update document | Update or create an attachment to a draft or an in-process envelope |
| Delete document | Deletes one or more documents from an existing envelope that has not been completed | |
| Retrieve documents | Retrieves a single document or all documents from an envelope | |
| Envelope recipients | Bulk create or update recipient | Updates or creates a recipient of a draft envelope or corrects a recipient information for an in-process envelope |
| Delete recipient | Deletes a recipient from a draft or a sent envelope | |
| Retrieve recipients | Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list | |
| Envelopes | Create envelope | Creates and sends an envelope or creates a draft envelop |
| Retrieve envelopes | Retrieves the DocuSign envelopes | |
| Update envelope | Updates an envelope |
Examples
Use templates to quickly create flows for DocuSign
Learn how to use App Connect templates to quickly create flows that perform actions on DocuSign. For example, open Discover, and then search for DocuSign.