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

ConnectConfigurations Resource

The ConnectConfigurations resource enables you to configure the DocuSign Connect service for your account.

You can use this resource to configure account-level webhooks that send notifications about every envelope sent from your account. You can set account-level webhooks to listen for events for envelopes sent by a specific user on your account, by multiple specific users, or from any of the users on your account. These events will be tracked, and can be delivered to a listening application.

Note: To use DocuSign Connect, it must be enabled in your DocuSign account. It is not enabled by default.

Aggregated Messages

To avoid duplicate simultaneous events, you can configure Connect to aggregate similar events into a single delivery. By default, aggregation is enabled on all Connect configurations. Similar or simultaneous events will be aggregated so your listener doesn't receive extraneous messages.

For example, when the final recipient signs an envelope, the system delivers a single, aggregated Connect event, rather than separate Recipient: complete and Envelope: complete messages. This aggregation process ensures that you only receive the minimal viable number of messages about an envelope's life cycle.

Send Individual Messages

When you enable Send Individual Messages (SIM) mode on a Connect configuration, DocuSign will deliver notifications for all envelope events individually. In contrast with aggregated messages, when a final recipient completes an envelope, your listener will receive a single Recipient: complete event followed by a single Envelope: complete event for the final participating party on the agreement. If you need more granular control over event notifications, you can enable SIM mode in the Admin area of the RADmin console. For more information about SIM mode, see Using Connect's New Send Individual Messages Feature.

Note: To create an envelope-level webhook instead of using account-level webhooks, use the Envelopes::Create method and add an eventNotification object to an envelope object.

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.

}} />