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

Connect Category

The Connect service 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.

Connect can empower your organization to manage document actions as they occur, and allows you to track their changes within your own systems. Upon completion, envelope information, including document content, can be stored in your own databases or CMS systems, and these events can be triggered via webhooks delivering messages to your application.

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. You can also use other techniques such as proxy servers and DMZ networking for receiving the incoming calls.

Connect delivers events over HTTP requests in the form of XML. DocuSign sends an XML object to the secure URL entered on the configuration page for every event and user selected.

If your application is not configured to accept post messages, DocuSign will NOT return an additional post error response to your listener application. If you've enabled logging on your configuration, it will be logged in Admin under the configuration failure log.

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

Contains information about a DocuSign Connect configuration.

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

Get Connect Configuration Information

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

Updates a specified Connect configuration.

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

Creates a connect configuration for the specified account.

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

Gets the details about a Connect configuration.

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

Deletes the specified connect configuration.

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

Returns users from the configured Connect service.

ConnectEvents

Connect event logging information. This object contains sections for regular Connect logs and for Connect failures.

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

Republishes Connect information for the specified envelope.

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

Republishes Connect information for multiple envelopes.

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

Gets the Connect failure log information.

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

Deletes a Connect failure log entry.

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

Gets the Connect log.

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

Deletes a list of Connect log entries.

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

Gets a Connect log entry.

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

Deletes a specified Connect log entry.

}} />