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

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

Creates a connect configuration for the specified account.

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

Deletes the specified connect configuration.

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

Get information on a Connect Configuration

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

Get Connect Configuration Information

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

Returns users from the configured Connect service.

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

Updates a specified Connect configuration.

ConnectEvents

Connect event logging

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

Deletes a specified Connect log entry.

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

Deletes a Connect failure log entry.

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

Gets a list of Connect log entries.

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

Get the specified Connect log entry.

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

Gets the Connect log.

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

Gets the Connect failure log information.

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 multiple envelopes.