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 Options demo, www, eu	Environment of the connection.	true
baseUri	Account Base URI	STRING	DocuSign account base URI.	true

Connection Setup

Create DocuSign App

Navigate to DocuSign Admin page.
Click on "Add App and Integration Key".
Enter app name and click on "Create App".
Here you can see your "Integration Key".
Select "Third-party integration key".
Click here.
Click on "Add Secret Key".
Copy your "Secret Key" because you will not be able to access it again.
Click on "Add URI".
Add https://app.bytechef.io/callback or http://127.0.0.1:5173/callback.
Click this icon.
Check every HTTP method.
Click on "Save".
Here you can see "API Account ID" and "Account Base URI".

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 Options sent, 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"
}

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 On fromDate	The ID of the envelope.	true
documentId	Document ID	STRING Depends On envelopeId	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"
}

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

Find Envelope and Document ID

To find the Envelope ID, click here.

To find the Document ID, click here.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

How to find Envelope ID

Login into your DocuSign account.
Click on Agreements.
Select the envelope you want to find ID of.
URL will be in the format https://apps.docusign.com/send/documents/details/b8f79238-1164-4c24-9629-01ca78dc63cf
Envelope ID will be b8f79238-1164-4c24-9629-01ca78dc63cf in this case. *. You will also be able to see Copy Envelope ID to clipboard button, when you click on it, you will have the envelope ID in your clipboard.

How to find Document ID

Login into your DocuSign account.
Click on Agreements.
Select the envelope you want document ID from.
Open document you want to find ID of.
URL will be in the format https://apps.docusign.com/api/send/api/accounts/f4a3a35c-e5c1-46c5-afa0-b9ad3b28efea/envelopes/b8f79238-1164-4c24-9629-01ca78dc63cf/documents/1/preview/name
Document ID will be after /documents/, in this case document ID is 1.

DocuSign

On this page