ByteChefComponents
DocuSign
DocuSign is a cloud-based e-signature platform that enables secure digital document signing and workflow automation.
Categories: Productivity and Collaboration
Type: docusign/v1
Connections
Version: 1
oauth2_authorization_code
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| clientId | Integration Key | STRING | DocuSign app integration key. | true |
| clientSecret | Secret Key | STRING | DocuSign app secret key. | true |
| accountId | API Account ID | STRING | DocuSign API account ID. | true |
| environment | Environment | STRING Optionsdemo, www, eu | Environment of the connection. | true |
| baseUri | Account Base URI | STRING | DocuSign account base URI. | true |
Actions
Create Envelope
Name: createEnvelope
Creates a new envelope.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| documents | Documents | ARRAY Items[{FILE_ENTRY(documentFile), STRING(name), INTEGER(documentId)}($document)] | The documents to be signed. | true |
| status | Status | STRING Optionssent, created | The status of the envelope. | true |
| emailSubject | Email Subject | STRING | The subject of the email used to send the envelope. | true |
| signers | Signer Recipients | ARRAY Items[{STRING(name), STRING(email), INTEGER(recipientId)}($recipient)] | The recipients of the envelope that have to sign the documents inside it. | true |
| carbonCopies | Cc Recipients | ARRAY Items[{STRING(name), STRING(email), INTEGER(recipientId)}($recipient)] | The recipients of the envelope that can only view the documents inside it. | false |
Example JSON Structure
{
"label" : "Create Envelope",
"name" : "createEnvelope",
"parameters" : {
"documents" : [ {
"documentFile" : {
"extension" : "",
"mimeType" : "",
"name" : "",
"url" : ""
},
"name" : "",
"documentId" : 1
} ],
"status" : "",
"emailSubject" : "",
"signers" : [ {
"name" : "",
"email" : "",
"recipientId" : 1
} ],
"carbonCopies" : [ {
"name" : "",
"email" : "",
"recipientId" : 1
} ]
},
"type" : "docusign/v1/createEnvelope"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| envelopeid | STRING | The id of the envelope. |
| uri | STRING | A URI containing the user ID. |
| statusDateTime | STRING | The DateTime that the envelope changed status (i.e. was created or sent.) |
| status | STRING | Indicates the envelope status. |
Output Example
{
"envelopeid" : "",
"uri" : "",
"statusDateTime" : "",
"status" : ""
}Download Envelope Document
Name: downloadEnvelopeDocument
Downloads a single document or all documents from an envelope.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| fromDate | From Date | DATE | Envelops that were created from this date will be fetched. | true |
| envelopeId | Envelope ID | STRING Depends OnfromDate | The ID of the envelope. | true |
| documentId | Document ID | STRING Depends OnenvelopeId | ID of the document that will be downloaded from the envelope. | true |
Example JSON Structure
{
"label" : "Download Envelope Document",
"name" : "downloadEnvelopeDocument",
"parameters" : {
"fromDate" : "2021-01-01",
"envelopeId" : "",
"documentId" : ""
},
"type" : "docusign/v1/downloadEnvelopeDocument"
}Output
Type: FILE_ENTRY
Properties
| Name | Type | Description |
|---|---|---|
| extension | STRING | |
| mimeType | STRING | |
| name | STRING | |
| url | STRING |
Output Example
{
"extension" : "",
"mimeType" : "",
"name" : "",
"url" : ""
}