{"api":"esign_rest","category":"reference"}

Connect Category

The Connect category enables your application to be called via HTTPS when an event of interest occurs.

Use the Connect service to "end the polling madness." With Connect, there is no need for your application to poll DocuSign every 15 minutes to learn the latest about your envelopes.

Instead, you register your interest in one or more types of envelope or recipient events. Then, when an interesting event occurs, the DocuSign platform will contact your application with the event's details and data. You can register interest in envelopes sent by particular users in your account, or for envelopes sent by any user.

Incoming Connect Calls

To use the Connect service, your application needs to provide an https url that can be called from the public internet. If your application runs on a server behind your organization's firewall, then you will need to create a "pinhole" in the firewall to allow the incoming Connect calls from DocuSign to reach your application. Other techniques for receiving the incoming calls including proxy servers and DMZ networking can also be used.

Per-envelope Connect Configuration

Instead of registering a general Connect configuration and listener, an individual envelope can have its own Connect configuration. See the eventNotification field for envelopes.

Categories

Use the Connect category for:

  • Programmatically creating Connect configurations. Connect configurations can be created manually by using the DocuSign web service, or programmatically via the API. Configurations created via the API can be seen and updated from the web service.
  • Retrieving and managing the event log for your Connect configurations.
  • Requesting that an event be re-published to the listener.

ConnectConfigurations

Connect configurations

MethodDescription
list
GET /v2/accounts/{accountId}/connect

Retrieves all the DocuSign Custom Connect definitions for the specified account.

Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.

update
PUT /v2/accounts/{accountId}/connect

Updates the specified DocuSign Connect configuration in your account.

Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.

create
POST /v2/accounts/{accountId}/connect

Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. Be aware that, these updates might or might not include the document itself. For more information about Connect, see the [ML:DocuSign Connect Service Guide].

Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

get
GET /v2/accounts/{accountId}/connect/{connectId}

Retrieves the information for the specified DocuSign Connect configuration.

Note: Connect must be enabled for your account to use this function.

delete
DELETE /v2/accounts/{accountId}/connect/{connectId}

Deletes the specified DocuSign Connect configuration.

Note: Connect must be enabled for your account to use this function.

listUsers
GET /v2/accounts/{accountId}/connect/{connectId}/users

Returns users from the configured Connect service.

ConnectEvents

Connect event logging

MethodDescription
retryForEnvelope
PUT /v2/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue

Republishes Connect information for the specified envelope.

retryForEnvelopes
PUT /v2/accounts/{accountId}/connect/envelopes/retry_queue

Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [ML:GetConnectLog] retrieve the failure log.

listFailures
GET /v2/accounts/{accountId}/connect/failures

Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

deleteFailure
DELETE /v2/accounts/{accountId}/connect/failures/{failureId}

Deletes the Connect failure log information for the specified entry.

list
GET /v2/accounts/{accountId}/connect/logs

Retrieves a list of connect log entries for your account.

Note: The enableLog setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

deleteList
DELETE /v2/accounts/{accountId}/connect/logs

Retrieves a list of connect log entries for your account.

Note: The enableLog property in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

get
GET /v2/accounts/{accountId}/connect/logs/{logId}

Retrieves the specified Connect log entry for your account.

Note: The enableLog setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.

delete
DELETE /v2/accounts/{accountId}/connect/logs/{logId}

Deletes a specified entry from the Connect Log.