Retrieves the information for the specified DocuSign Connect configuration.

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

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

connectIdstring

The ID of the custom Connect configuration being accessed.

Responses

CodeDescriptionReference
200

Successful response.

connectConfigResults
400

Error encountered.

errorDetails

SDK Method

Connect::getConfiguration

Definitions

connectConfigResults

This object contains the results of a ConnectConfigurations::GET method.

configurations[connectCustomConfiguration]

An array of DocuSign Connect configurations.

totalRecordsstring

The number of results.

connectCustomConfiguration

allowEnvelopePublishstring

When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.

allowSalesforcePublishstring

When set to true (default), DocuSign sends data to the designated Salesforce account through Connect.

allUsersstring

When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.

configurationTypestring

If you are using merge fields, this property specifies the type of the merge field. The only supported value is salesforce.

connectIdstring

The ID of the custom Connect configuration being accessed.

enableLogstring

When set to true, Connect logging is turned on. We recommend that you enable this functionality, which helps you troubleshoot any issues.

You can have a maximum of 100 active logs in your account. You can view the entries in active logs in the Logs tab in the console.

envelopeEvents[array]

A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the url property.

To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

externalFolderIdstring

The id of an external folder.

externalFolderLabelstring

The label for an external folder.

includeCertificateOfCompletionstring

When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.

includeCertSoapHeaderstring

includeDocumentFieldsstring

When set to true, the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API.

includeDocumentsstring

reserved

includeEnvelopeVoidReasonstring

When set to true, if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope.

includeHMACstring

includeSenderAccountasCustomFieldstring

When set to true, Connect will include the sender account as Custom Field in the data.

includeTimeZoneInformationstring

When set to true, Connect will include the envelope time zone information.

namestring

passwordstring

The user's encrypted password hash.

recipientEvents[array]

An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the url endpoint specified in the url property.

To receive notifications, you must include either an envelopeEvents node or a recipientEvents node. You do not need to specify both.

requireMutualTlsstring

When set to true, Mutual TLS authentication is enabled.

requiresAcknowledgementstring

When set to true, event delivery acknowledgements are enabled for your Connect configuration.

DocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.

When set to true and Send Individual Messages (SIM) mode is activated

If the HTTP status response to a notification message is not in the range of 200-299, then the message delivery failed, and the configuration is marked as down.

The message will be queued and retried once per day. While a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason Pending. When a message succeeds, all queued messages for the configuration will be tried immediately, in order.

There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.

When set to true and SIM mode is not activated

If the HTTP Status response to a notification message is not in the range of 200-299, then the message delivery failed, and the message is queued.

The message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription). Subsequent notifications will be tried when they occur. There is a maximum of ten retries. Alternately, you can use Republish Connect Information to manually republish the notification.

When set to false

When requiresAcknowledgement is set to false and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.

salesforceApiVersionstring

The version of the Salesforce API that you are using.

salesforceAuthcodestring

salesforceCallBackUrlstring

salesforceDocumentsAsContentFilesstring

When set to true, DocuSign can use documents in your Salesforce account for sending and signing.

senderOverridestring

senderSelectableItems[array]

This property sets the items that are available for selection when adding or editing Connect objects.

sfObjects[connectSalesforceObject]

An array of Salesforce objects.

signMessageWithX509Certificatestring

When set to true, Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol.

soapNamespacestring

The namespace of the SOAP interface.

Note: If useSoapInterface is set to true, you must set this value.

urlToPublishTostring

This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.

userIds[array]

A comma-separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.

Note: If allUsers is set to false then you must provide a list of user ids.

userNamestring

The name of the user.

useSoapInterfacestring

When set to true, the notifications are sent to your endpoint as SOAP requests.

connectSalesforceField

This object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account.

dsAttributestring

dsLinkstring

A URL that links to the information in the DocuSign field.

dsNodestring

idstring

A unique ID for the Salesforce object.

sfFieldstring

sfFieldNamestring

The name of the Salesforce field.

sfFolderstring

The name of the Salesforce folder.

sfLockedValuestring

connectSalesforceObject

A connectSalesforceObject is an object that updates envelope and document status or recipient status in your Salesforce account.

When you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments.

activestring

When set to true, the connectSalesforceObject is active.

descriptionstring

A description of the connectSalesforceObject.

idstring

The id of the connectSalesforceObject.

insertstring

onCompleteOnlystring

When true, Salesforce is updated only when the envelope is complete.

selectFields[connectSalesforceField]

The DocuSign and Salesforce fields that you want to use to match a Salesforce object with DocuSign information. This information tells Connect when to send updates to Salesforce.

sfObjectstring

The Salesforce.com object type, such as case, contact, or opportunity.

sfObjectNamestring

A name for the Salesforce object.

Note: You can enter any name for the object. It does not have to match the sfObject property.

updateFields[connectSalesforceField]

The DocuSign and Salesforce fields that you want to update.

Note: You can choose to update SalesForce (with information from DocuSign) only, update DocuSign only, or both.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Examples

Generic JSON Response

Response
{
  "configurations": [
    {
      "connectId": "sample string 1",
      "configurationType": "sample string 2",
      "urlToPublishTo": "sample string 3",
      "name": "sample string 4",
      "allowEnvelopePublish": "sample string 5",
      "enableLog": "sample string 6",
      "includeDocuments": "sample string 7",
      "includeCertificateOfCompletion": "sample string 8",
      "requiresAcknowledgement": "sample string 9",
      "signMessageWithX509Certificate": "sample string 10",
      "useSoapInterface": "sample string 11",
      "includeTimeZoneInformation": "sample string 12",
      "includeEnvelopeVoidReason": "sample string 13",
      "includeSenderAccountasCustomField": "sample string 14",
      "envelopeEvents": "sample string 15",
      "recipientEvents": "sample string 16",
      "userIds": "sample string 17",
      "soapNamespace": "sample string 18",
      "allUsers": "sample string 19",
      "includeCertSoapHeader": "sample string 20",
      "includeDocumentFields": "sample string 21"
    }
  ],
  "totalRecords": "sample string 1"
}
Generic XML Response

Response
<connectConfigResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <configurations>
    <connectCustomConfiguration>
      <allUsers>sample string 19</allUsers>
      <allowEnvelopePublish>sample string 5</allowEnvelopePublish>
      <configurationType>sample string 2</configurationType>
      <connectId>sample string 1</connectId>
      <enableLog>sample string 6</enableLog>
      <envelopeEvents>sample string 15</envelopeEvents>
      <includeCertSoapHeader>sample string 20</includeCertSoapHeader>
      <includeCertificateOfCompletion>sample string 8</includeCertificateOfCompletion>
      <includeDocumentFields>sample string 21</includeDocumentFields>
      <includeDocuments>sample string 7</includeDocuments>
      <includeEnvelopeVoidReason>sample string 13</includeEnvelopeVoidReason>
      <includeSenderAccountasCustomField>sample string 14</includeSenderAccountasCustomField>
      <includeTimeZoneInformation>sample string 12</includeTimeZoneInformation>
      <name>sample string 4</name>
      <recipientEvents>sample string 16</recipientEvents>
      <requiresAcknowledgement>sample string 9</requiresAcknowledgement>
      <signMessageWithX509Certificate>sample string 10</signMessageWithX509Certificate>
      <soapNamespace>sample string 18</soapNamespace>
      <urlToPublishTo>sample string 3</urlToPublishTo>
      <useSoapInterface>sample string 11</useSoapInterface>
      <userIds>sample string 17</userIds>
    </connectCustomConfiguration>
  </configurations>
  <totalRecords>sample string 1</totalRecords>
</connectConfigResults> 
}} />