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.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

connectConfigResults
400

Error encountered.

errorDetails

SDK Method

Connect::listConfigurations

Definitions

connectConfigResults

configurations[ConnectConfigurations]

Array of Connect Configurations

totalRecordsstring

The count of records in the log list.

connectSalesforceField

dsAttributestring

dsLinkstring

dsNodestring

idstring

A unique ID for the Salesforce object.

sfFieldstring

sfFieldNamestring

sfFolderstring

sfLockedValuestring

connectSalesforceObject

activestring

descriptionstring

A sender-defined description of the line item.

idstring

A unique ID for the Salesforce object.

insertstring

onCompleteOnlystring

selectFields[connectSalesforceField]

sfObjectstring

sfObjectNamestring

The name of the Salesforce object.

updateFields[connectSalesforceField]

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.

ConnectConfigurations

Connect configurations

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

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 merge fields are being used, specifies the type of the merge field. The only supported value is salesforce.

connectIdstring

Read only: the DocuSign generated ID for the Connect configuration.

enableLogstring

This turns Connect logging on or off. When set to true, logging is turned on.

envelopeEvents[array]

An array of strings that lists envelope-related events that are tracked through Connect. The possible event values are:

  • sent
  • delivered
  • completed
  • declined
  • voided

Note: In previous versions of the API, this value was a single comma-separated string.

externalFolderIdstring

externalFolderLabelstring

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

When set to true, Connect will send the PDF document along with the update XML.

includeEnvelopeVoidReasonstring

When set to true, Connect will include the voidedReason for voided envelopes.

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

The name of the Connect configuration. The name helps identify the configuration in the list.

passwordstring

The user's encrypted password hash.

recipientEvents[array]

An array of strings that lists of recipient-related events that trigger a notification to your webhook Connect listener. The possible event values are:

  • sent
  • delivered
  • completed
  • declined
  • authenticationfailed
  • autoresponded

Note: In previous versions of the API, this value was a single comma-separated string.

requireMutualTlsstring

If true Mutual TLS authentication is enabled.

requiresAcknowledgementstring

When set to true, and 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, they'll be immediately queued with reason "Pending". Once 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.

salesforceAccessTokenstring

The access token to use for Salesforce integration.

salesforceApiVersionstring

The version of the Salesforce API that you are using.

salesforceDocumentsAsContentFilesstring

salesforceRefreshTokenstring

senderOverridestring

senderSelectableItems[array]

sfObjects[connectSalesforceObject]

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.

The namespace value must be set if useSoapInterface is set to true.

urlToPublishTostring

The endpoint to which webhook notification messages are sent via an HTTPS POST request. The url must start with https. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not ok. Free certificates from Let's Encrypt can be used.

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, indicates that the urlToPublishTo property contains a SOAP endpoint.

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> 
}} />