Connectors Reference

DocuSign

DocuSign is the easiest and most secure way to sign and get documents signed. With over 50 million users worldwide, DocuSign is the most widely used eSignature and Digital Transaction Management platform in the world.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

DeleteHook (string accountId, string connectId)

Delete hook

GetDocuments (string accountId, string envelopeId, [internal]string documentId, boolean certificate)

Get envelope documents

SendEnvelope (string accountId, string templateId, string status, DynamicSigners signers)

Send envelope using template

SendDraftEnvelope (string accountId, string envelopeId)

Send envelope

GetRecipientStatus (string accountId, string folderId, string envelopeId)

List recipients

AddRecipientToEnvelope (string accountId, string envelopeId, string AddRecipientToEnvelopeName, string AddRecipientToEnvelopeEmail, AddRecipientToEnvelopeRequest newRecipient)

Add recipient to an envelope

RemoveRecipientFromEnvelope (string accountId, string folderId, string envelopeId, string RemoveRecipientFromEnvelopeRecipientId)

Remove recipient from an envelope

GetLoginAccounts ()

Login

GetEnvelopeTemplates (string accountId)

List templates

GetFolderList (string accountId)

List folders

GetFolderEnvelopeList (string accountId, string folderId)

List envelopes

GetEnvelopeDocumentList (string accountId, string folderId, string envelopeId)

List documents

GetDynamicSigners (string accountId, string templateId)

Get the signers of a template in dynamic schema format.

WebhookResponse ([Optional]string logicAppsUri)

 

 

Triggers:

Name

Summary

CreateHookEnvelope (string accountId, [Optional]WebhookRequest body)

When an envelope status changes (Connect)

OnEnvelopeStatusChanges (string accountId, [Optional]string status)

When an envelope status changes

 

Objects:

Name

Summary

AddRecipientToEnvelopeRequest

 

DynamicSigners

 

Envelope

 

EnvelopeDocument

 

EnvelopeTemplate

 

Folder

 

FolderItem

 

GetLoginAccountsResponse

 

ListDocumentsResponse

 

ListEnvelopesResponse

 

ListFoldersResponse

 

ListRecipientsResponse

 

ListTemplatesResponse

 

LoginAccount

 

OnEnvelopeStatusChangesResponse

 

SendDraftEnvelopeResponse

 

SendEnvelopeResponse

 

Signer

 

SignerRequest

 

WebhookRequest

 

 

Actions:

DeleteHook

Summary: Delete hook

Description: Delete a hook.

 

Syntax:

DocuSign.DeleteHook (string accountId, string connectId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

 

 

True

connectId

string

 

 

True

 

Returns:

 

GetDocuments

Summary: Get envelope documents

Description: Get envelope documents.

 

Syntax:

DocuSign.GetDocuments (string accountId, string envelopeId, [internal]string documentId, boolean certificate)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

envelopeId

string

(Envelope)

Envelope id

True

documentId

string

(Document)

Document id

True

certificate

boolean

(Certificate of completion)

When set to false, the envelope signing certificate is removed from the download.

True

 

Returns:

          Type:string

          Summary: File Content

 

SendEnvelope

Summary: Send envelope using template

Description: Send a new envelope using a specified template.

 

Syntax:

DocuSign.SendEnvelope (string accountId, string templateId, string status, DynamicSigners signers)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

templateId

string

(Template)

Template id

True

GetEnvelopeTemplates

status

string

(Envelope status)Values: [Sent, Created]

Envelope status

True

signers

DynamicSigners

 

An object that represents signers based on a template.

True

 

Returns:

          Type:SendEnvelopeResponse

 

SendDraftEnvelope

Summary: Send envelope

Description: Send an existing envelope.

 

Syntax:

DocuSign.SendDraftEnvelope (string accountId, string envelopeId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

envelopeId

string

(Envelope)

Envelope id

True

 

Returns:

          Type:SendDraftEnvelopeResponse

 

GetRecipientStatus

Summary: List recipients

Description: List recipients for a specific envelope.

 

Syntax:

DocuSign.GetRecipientStatus (string accountId, string folderId, string envelopeId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

folderId

string

(Folder)

Folder id

True

GetFolderList

envelopeId

string

(Envelope)

Envelope id

True

GetFolderEnvelopeList

 

Returns:

          Type:ListRecipientsResponse

 

AddRecipientToEnvelope

Summary: Add recipient to an envelope

Description: Add recipient to an envelope

 

Syntax:

DocuSign.AddRecipientToEnvelope (string accountId, string envelopeId, string AddRecipientToEnvelopeName, string AddRecipientToEnvelopeEmail, AddRecipientToEnvelopeRequest newRecipient)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

envelopeId

string

(Envelope)

Envelope id

True

AddRecipientToEnvelopeName

string

(Signer Name)

The name of the recipient.

True

AddRecipientToEnvelopeEmail

string

(Signer Email)

The email of the recipient.

True

newRecipient

AddRecipientToEnvelopeRequest

 

 

True

 

Returns:

          Type:ListRecipientsResponse

 

RemoveRecipientFromEnvelope

Summary: Remove recipient from an envelope

Description: Remove recipient from an envelope

 

Syntax:

DocuSign.RemoveRecipientFromEnvelope (string accountId, string folderId, string envelopeId, string RemoveRecipientFromEnvelopeRecipientId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

folderId

string

(Folder)

Folder id

True

GetFolderList

envelopeId

string

(Envelope)

Envelope id

True

GetFolderEnvelopeList

RemoveRecipientFromEnvelopeRecipientId

string

(Recipient)

Recipient id

True

GetRecipientStatus

 

Returns:

          Type:ListRecipientsResponse

 

GetLoginAccounts

Summary: Login

Description: Login

 

Syntax:

DocuSign.GetLoginAccounts ()

 

Returns:

          Type:GetLoginAccountsResponse

 

GetEnvelopeTemplates

Summary: List templates

Description: List templates for a specific account.

 

Syntax:

DocuSign.GetEnvelopeTemplates (string accountId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

 

Returns:

          Type:ListTemplatesResponse

 

GetFolderList

Summary: List folders

Description: List folders for a specific account.

 

Syntax:

DocuSign.GetFolderList (string accountId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

 

Returns:

          Type:ListFoldersResponse

 

GetFolderEnvelopeList

Summary: List envelopes

Description: List envelopes under a particular folder.

 

Syntax:

DocuSign.GetFolderEnvelopeList (string accountId, string folderId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

folderId

string

(Folder)

Folder id

True

GetFolderList

 

Returns:

          Type:ListEnvelopesResponse

 

GetEnvelopeDocumentList

Summary: List documents

Description: List documents in an envelope.

 

Syntax:

DocuSign.GetEnvelopeDocumentList (string accountId, string folderId, string envelopeId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

folderId

string

(Folder)

Folder id

True

GetFolderList

envelopeId

string

(Envelope)

Envelope id

True

GetFolderEnvelopeList

 

Returns:

          Type:ListDocumentsResponse

 

GetDynamicSigners

Summary: Get the signers of a template in dynamic schema format.

Description: Get the signers of a template in dynamic schema format.

 

Syntax:

DocuSign.GetDynamicSigners (string accountId, string templateId)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account Id)

Account to get the signers for.

True

templateId

string

(Template Id)

Template to get the signers for.

True

 

Returns:

          Type:string

 

WebhookResponse

Summary:

Description:

 

Syntax:

DocuSign.WebhookResponse ([Optional]string logicAppsUri)

 

Parameters:

Name

Type

Summary

Required

Related Action

logicAppsUri

string

 

 

False

 

Returns:

 

Triggers:

Trigger CreateHookEnvelope

Summary: When an envelope status changes (Connect)

Description: Triggers a new flow when an envelope status changes.

 

Syntax:

DocuSign.CreateHookEnvelope (string accountId, [Optional]WebhookRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

body

WebhookRequest

 

 

False

 

Returns:

          Type:string

 

Trigger OnEnvelopeStatusChanges

Summary: When an envelope status changes

Description: Triggers a new flow when an envelope status changes.

 

Syntax:

DocuSign.OnEnvelopeStatusChanges (string accountId, [Optional]string status)

 

Parameters:

Name

Type

Summary

Required

Related Action

accountId

string

(Account)

Account id

True

GetLoginAccounts

status

string

(Envelope status)Values: [Any, Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut, Template, Processing]

 

False

 

Returns:

          Type:OnEnvelopeStatusChangesResponse

 


 

AddRecipientToEnvelopeRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

signers

array of (SignerRequest)

Signer

 


 

DynamicSigners

Summary:

Description: An object that represents signers based on a template.

 

          Properties:

Name

Type

Summary


 

Envelope

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentsUri

string

Documents URI

The URI for the document in DocuSign.

envelopeId

string

Envelope Id

The id of the envelope.

envelopeUri

string

Envelope URI

The URI for the envelope in DocuSign.

notificationUri

string

Notification URI

The URI for the notifications.

recipientsUri

string

Recipients URI

The URI for the recipients of the envelope in DocuSign.

status

string

Status

The status of the envelope.

statusChangedDateTime

string

Status Changed Datetime

The datetime the status changed.


 

EnvelopeDocument

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentId

string

Document Id

The id of the document.

name

string

Name

The name of the document.


 

EnvelopeTemplate

Summary:

Description:

 

          Properties:

Name

Type

Summary

templateId

string

Template Id

The id of the template.

name

string

Name

The name of the template.


 

Folder

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the folder.

folderId

string

Folder Id

The id of the folder.


 

FolderItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

envelopeId

string

Envelope id

The id of the envelope.

subject

string

Subject

The subject of the envelope.


 

GetLoginAccountsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

loginAccounts

array of (LoginAccount)

Login accounts

Login accounts


 

ListDocumentsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

envelopeDocuments

array of (EnvelopeDocument)

Envelope documents

The documents attached to the envelope.


 

ListEnvelopesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

folderItems

array of (FolderItem)

Folder items

The envelopes within a folder.


 

ListFoldersResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

folders

array of (Folder)

Folders

Folders


 

ListRecipientsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

signers

array of (Signer)

Signers

Signers


 

ListTemplatesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

envelopeTemplates

array of (EnvelopeTemplate)

Envelope templates

The availalbe envelope templates.


 

LoginAccount

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the account.

accountIdGuid

string

Account Id guid

The GUID of the account.


 

OnEnvelopeStatusChangesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

envelopes

array of (Envelope)

Envelopes

Envelopes


 

SendDraftEnvelopeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SendEnvelopeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

envelopeId

string

Envelope Id

The id of the envelope.

status

string

Status

The status of the envelope.

statusDateTime

string

Status date time

The datetime the status was set.

uri

string

URI

The URI for the envelope in DocuSign.


 

Signer

Summary:

Description:

 

          Properties:

Name

Type

Summary

routingOrder

string

Signing Order

The signing order of the recipient in the document.

roleName

string

Role

The role of the signer.

recipientId

string

Recipient Id

The id the recipient.

name

string

Name

The name of the recipient.

email

string

Email

The email of the recipient.


 

SignerRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

routingOrder

string

Signing Order

The signing order of the recipient in the document.

roleName

string

Role

The role of the signer.

recipientId

string

Recipient Id

The id the recipient.

name

string

Name

The name of the recipient.

email

string

Email

The email of the recipient.


 

WebhookRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

allUsers

string

allUsers

 

allowEnvelopePublish

string

allowEnvelopePublish

 

includeDocumentFields

string

includeDocumentFields

 

includeEnvelopeVoidReason

string

includeEnvelopeVoidReason

 

includeTimeZoneInformation

string

includeTimeZoneInformation

 

requiresAcknowledgement

string

requiresAcknowledgement

 

urlToPublishTo

string

urlToPublishTo

 

name

string

Connect name

 

envelopeEvents

string

Envelope event

Values: [Sent, Delivered, Completed, Declined, Voided]

includeSenderAccountasCustomField

string

includeSenderAccountasCustomField