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.

Availability:
  • A connector in IBM App Connect Enterprise as a ServiceApp Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 12.0.7.0-r1 or later

Connecting to DocuSign

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your DocuSign administrator to obtain these values.

To connect App Connect to a DocuSign account, select your preferred authorization type:
  • 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
Then, specify values in the connection fields for your chosen authorization method:
Table 1. Connection fields for your chosen authorization method. Descriptions of the connection fields are given after this table.
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  
Table 2. Description of the connection fields
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.
Tip: For more information, see Endpoints on the DocuSign Developer page.
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 and to connect to IBM® App Connect, do the following steps:
Note: Choose the applicable steps for the connection values based on the authorization method you selected.
  1. Log in to your DocuSign Developer account.
  2. To find your user ID and generate an integration key:
    1. Go to Settings > Apps and Keys.
    2. Copy the User ID under My Account Information and save it somewhere safe.
    3. Click ADD APP AND INTEGRATION KEY, enter an application name, then click CREATE APP.
    4. Copy the Integration Key linked to your application and save it somewhere safe.
    5. For more information, see Integration keys on the DocuSign Developer page.
  3. To generate an RSA private key:
    1. Go to Settings > Apps and Keys.
    2. Make sure that you already have an application created.
    3. Choose the application to configure, then click Edit in the ACTIONS drop-down menu.
    4. Under the Service Integration section, click GENERATE RSA.
    5. In the RSA Keypair window, copy the Private Key and save it somewhere safe. This is your RSA private key.
    6. For more information, see RSA key pair on the DocuSign Developer page.
  4. To generate an access token and a refresh token by using the client ID and client secret, see How to get an access token with JWT Grant or How to get an access token with Authorization Code Grant on the DocuSign Developer page.
    Note: You need to use an application such as IBM API Connect Test and Monitor or Postman to submit a POST request.

To connect to a DocuSign endpoint from the App Connect Designer Catalog page for the first time, expand DocuSign, then click Connect.

Tip:

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 Catalog 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 Catalog page of the App Connect Designer.

    For some applications, the events and actions in the catalog 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.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

DocuSign actions

Your flow completes these actions on this application.

Attachments
Create attachment
Retrieve attachments
Update attachment
Delete attachment
Documents
Retrieve documents
Bulk create or update document
Delete document
Envelope recipients
Retrieve recipients
Bulk create or update recipient
Delete recipient
Envelopes
Create envelope
Retrieve envelopes
Update envelope

Examples

Dashboard tile for a template that uses DocuSign

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 the Templates gallery, and then search for DocuSign.

Learn more