> For the complete documentation index, see [llms.txt](https://docs.planetcrust.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.planetcrust.com/human-connections/docusign/docusign.md).
# Docusign
Try @Human Buy @Human Subscription Join @Human Community
Put Docusign to Work with @Human Automations and @Human Agents
The Docusign Connection documents all Triggers, Actions and Query Operations available for creating automations via the Docusign API.
{% embed url="" %}
#### What can you do with the Docusign Connection?
* Connect to the Docusign API in a few clicks
* Use the related Docusign Operations (see below) in @Human Automations or @Human Agents
### Related Operations
#### Trigger Operations
**Envelope Sent**
Triggers on: envelopes/envelopeSent
Triggered when an envelope is successfully sent.
**Envelope Completed**
Triggers on: envelopes/envelopeCompleted
Triggered when an envelope is completely signed and ready.
#### Action Operations
[Action: Add Document to Workspace](/human-connections/docusign/docusign/action-add-document-to-workspace.md)
[Action: Add User to Workspace](/human-connections/docusign/docusign/action-add-user-to-workspace.md)
[Action: Create Bulk Send List](/human-connections/docusign/docusign/action-create-bulk-send-list.md)
[Action: Create Envelope From Workspace](/human-connections/docusign/docusign/action-create-envelope-from-workspace.md)
[Action: Create Workspace](/human-connections/docusign/docusign/action-create-workspace.md)
[Action: Download Envelope Document](/human-connections/docusign/docusign/action-download-envelope-document.md)
[Action: Send Envelope Using Template](/human-connections/docusign/docusign/action-send-envelope-using-template.md)
[Action: Cancel Maestro Workflow Instance](/human-connections/docusign/docusign/action-cancel-maestro-workflow-instance.md)
[Action: Resume Maestro Workflow Instance](/human-connections/docusign/docusign/action-resume-maestro-workflow-instance.md)
[Action: Create Pre-Filled Webform Link](/human-connections/docusign/docusign/action-create-pre-filled-webform-link.md)
[Action: Revoke Workspace User Access](/human-connections/docusign/docusign/action-revoke-workspace-user-access.md)
[Action: Test Bulk Send Request](/human-connections/docusign/docusign/action-test-bulk-send-request.md)
[Action: Update Workspace User](/human-connections/docusign/docusign/action-update-workspace-user.md)
[Action: API Request](/human-connections/docusign/docusign/action-api-request.md)
[Action: Add to Bulk Send List](/human-connections/docusign/docusign/action-add-to-bulk-send-list.md)
[Action: Bulk Send Envelope From Template](/human-connections/docusign/docusign/action-bulk-send-envelope-from-template.md)
[Action: Create Draft Signature Request](/human-connections/docusign/docusign/action-create-draft-signature-request.md)
[Action: Create Template from Document](/human-connections/docusign/docusign/action-create-template-from-document.md)
[Action: Delete Document From Workspace](/human-connections/docusign/docusign/action-delete-document-from-workspace.md)
[Action: Send Envelope Using Document](/human-connections/docusign/docusign/action-send-envelope-using-document.md)
[Action: Pause Maestro Workflow Instance](/human-connections/docusign/docusign/action-pause-maestro-workflow-instance.md)
[Action: Trigger Maestro Workflow](/human-connections/docusign/docusign/action-trigger-maestro-workflow.md)
[Action: Restore Workspace User Access](/human-connections/docusign/docusign/action-restore-workspace-user-access.md)
[Action: Create Signature Request](/human-connections/docusign/docusign/action-create-signature-request.md)
[Action: Update Template](/human-connections/docusign/docusign/action-update-template.md)
[Action: Void Envelope](/human-connections/docusign/docusign/action-void-envelope.md)
[Action: Create Envelope with Base URL and Account ID Input](/human-connections/docusign/docusign/action-create-envelope-with-base-url-and-account-id-input.md)
#### Query Operations
[Query: Find Documents List for Envelope](/human-connections/docusign/docusign/query-find-documents-list-for-envelope.md)
[Query: Find Envelope Info](/human-connections/docusign/docusign/query-find-envelope-info.md)
[Query: Find Maestro Workflow](/human-connections/docusign/docusign/query-find-maestro-workflow.md)
[Query: Find Maestro Workflow Instance](/human-connections/docusign/docusign/query-find-maestro-workflow-instance.md)
[Query: Find Template](/human-connections/docusign/docusign/query-find-template.md)
[Query: Find Workspaces](/human-connections/docusign/docusign/query-find-workspaces.md)
[Query: List Envelopes in Workspace](/human-connections/docusign/docusign/query-list-envelopes-in-workspace.md)
[Query: Find Custom Fields for Envelope](/human-connections/docusign/docusign/query-find-custom-fields-for-envelope.md)
[Query: Find Form Data for Envelope](/human-connections/docusign/docusign/query-find-form-data-for-envelope.md)
[Query: Find Recipients for Envelope](/human-connections/docusign/docusign/query-find-recipients-for-envelope.md)
[Query: Find Navigator Agreement](/human-connections/docusign/docusign/query-find-navigator-agreement.md)
[Query: Find Envelope Documents](/human-connections/docusign/docusign/query-find-envelope-documents.md)
[Query: Find Template Documents](/human-connections/docusign/docusign/query-find-template-documents.md)
[Query: Find Documents in Workspace](/human-connections/docusign/docusign/query-find-documents-in-workspace.md)
[Query: List Users in Workspace](/human-connections/docusign/docusign/query-list-users-in-workspace.md)
### Related Automations
Example link
### Obtaining Access Credentials
To obtain a **DocuSign Personal Access Token (PAT)** for system-to-system access, follow these steps:
#### **Prerequisites**
1. A **DocuSign Developer Account** (free at [developers.docusign.com](https://developers.docusign.com/)).
2. An **Integration Key (Client ID)** from a **DocuSign App** (created in the Developer Portal).
#### **Steps to Generate a PAT**
1. **Log in** to the [DocuSign Developer Portal](https://admindemo.docusign.com/).
2. Navigate to **"My Apps"** (under **"Apps and Keys"** in the left sidebar).
3. Select your **App** (or create one if needed).
4. Under **"Authentication"**, locate the **"Generate RSA Key Pair"** section.
5. Click **"Generate Key Pair"** (this creates a private/public key pair).
6. Download the **private key** (`.pem` file) and store it securely.
7. Under **"Personal Access Tokens"**, click **"Add Personal Access Token"**.
8. Provide a **name** and **scope** (e.g., `signature`).
9. Click **"Generate Token"**.
10. Copy the **generated PAT** (it will only be shown once).
#### **Required Values**
* **Integration Key (Client ID)** – From your DocuSign App.
* **User ID (GUID)** – Your DocuSign account GUID (found in **API Account Info**).
* **Private Key (RSA .pem file)** – Downloaded in Step 6.
* **Personal Access Token (PAT)** – Generated in Step 10.
Use these values for API authentication.
### Configuring Webhooks
1. **Log in** to your DocuSign account.
2. Navigate to the **Admin** tab.
3. In the left sidebar, under **Integrations**, select **Connect**.
4. Click **Add Configuration** and select **Custom**.
5. Provide a descriptive **Name** for the configuration.
6. Enter the **URL to Publish** (your webhook listener endpoint).
7. Select the **Data Format** (JSON is recommended).
8. Under **Event Triggers**, select the specific events you want to track (e.g., **Envelope Signed**).
9. Click **Add** to save the configuration.
### Code (Apache v2.0): Service Connectivity and Metadata
```
{
"handle": "docusign-v2",
"status": "active",
"meta": {
"short": "DocuSign",
"description": "Connect to DocuSign for electronic signatures and agreement workflows.",
"icon": "docusign",
"tags": ["e-signature", "documents", "agreements"]
},
"service": {
"baseURL": {
"value": "https://{{environment}}.docusign.net/restapi"
},
"protocol": "https",
"contentType": "application/json",
"headers": {
"Accept": {
"value": "application/json"
}
},
"auth": {
"method": "system_to_system",
"params": {}
}
}
}
```
### Code (Apache v2.0): List of External Resources and Internal Mapping
```
[
{
"handle": "envelopes",
"meta": {
"short": "Envelopes",
"description": "Manage and track envelopes for sending and signing documents."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/envelopes",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "envelopeId",
"type": "String",
"selector": ["envelopeId"],
"meta": {
"description": "Unique identifier for the envelope"
}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {
"description": "Current status of the envelope (e.g., 'sent', 'delivered', 'completed')"
}
},
{
"name": "emailSubject",
"type": "String",
"selector": ["emailSubject"],
"meta": {
"description": "Subject line of the email sent to recipients"
}
},
{
"name": "createdDateTime",
"type": "String",
"selector": ["createdDateTime"],
"meta": {
"description": "Timestamp when the envelope was created"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {},
"queryParams": {
"from_date": {
"value": "{{fromDate}}",
"placeholders": [
{
"name": "fromDate",
"type": "String",
"description": "Filter envelopes created after this date",
"required": false
}
]
}
}
},
"read": {
"method": "GET",
"path": {
"value": "/{{envelopeId}}",
"placeholders": [
{
"name": "envelopeId",
"type": "String",
"description": "The ID of the envelope to retrieve",
"required": true
}
]
},
"headers": {}
},
"create": {
"method": "POST",
"path": {
"value": "",
"placeholders": []
},
"headers": {
"Content-Type": {
"value": "application/json",
"placeholders": []
}
},
"bodyTemplate": {
"value": "{\"status\": \"{{status}}\", \"emailSubject\": \"{{emailSubject}}\", \"documents\": {{documents}}, \"recipients\": {\"signers\": {{signers}}}}",
"placeholders": [
{
"name": "status",
"type": "String",
"description": "Status of the envelope (e.g., 'sent')",
"required": true
},
{
"name": "emailSubject",
"type": "String",
"description": "Subject line of the email",
"required": true
},
{
"name": "documents",
"type": "Array",
"description": "List of documents in the envelope",
"required": true
},
{
"name": "signers",
"type": "Array",
"description": "List of signers for the envelope",
"required": true
}
]
}
}
},
"webhooks": [
{
"event": "envelopeSent",
"path": "/webhooks/docusign/envelope-sent",
"payload": [
{
"name": "envelopeId",
"type": "String",
"selector": ["envelopeId"],
"meta": {
"description": "ID of the envelope that was sent"
}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {
"description": "Status of the envelope"
}
}
]
},
{
"event": "envelopeCompleted",
"path": "/webhooks/docusign/envelope-completed",
"payload": [
{
"name": "envelopeId",
"type": "String",
"selector": ["envelopeId"],
"meta": {
"description": "ID of the envelope that was completed"
}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {
"description": "Status of the envelope"
}
}
]
}
]
},
{
"handle": "templates",
"meta": {
"short": "Templates",
"description": "Manage and use templates for creating envelopes."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/templates",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "templateId",
"type": "String",
"selector": ["templateId"],
"meta": {
"description": "Unique identifier for the template"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "Name of the template"
}
},
{
"name": "createdDateTime",
"type": "String",
"selector": ["createdDateTime"],
"meta": {
"description": "Timestamp when the template was created"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{templateId}}",
"placeholders": [
{
"name": "templateId",
"type": "String",
"description": "The ID of the template to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "recipients",
"meta": {
"short": "Recipients",
"description": "Manage recipients of envelopes, including signers and carbon copy recipients."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
},
{
"name": "envelopeId",
"type": "String",
"description": "The ID of the envelope",
"required": true
}
]
},
"fields": [
{
"name": "recipientId",
"type": "String",
"selector": ["recipientId"],
"meta": {
"description": "Unique identifier for the recipient"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "Name of the recipient"
}
},
{
"name": "email",
"type": "String",
"selector": ["email"],
"meta": {
"description": "Email address of the recipient"
}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {
"description": "Current status of the recipient (e.g., 'sent', 'delivered', 'completed')"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{recipientId}}",
"placeholders": [
{
"name": "recipientId",
"type": "String",
"description": "The ID of the recipient to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "users",
"meta": {
"short": "Users",
"description": "Manage users within a DocuSign account."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/users",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "userId",
"type": "String",
"selector": ["userId"],
"meta": {
"description": "Unique identifier for the user"
}
},
{
"name": "userName",
"type": "String",
"selector": ["userName"],
"meta": {
"description": "Name of the user"
}
},
{
"name": "email",
"type": "String",
"selector": ["email"],
"meta": {
"description": "Email address of the user"
}
},
{
"name": "userStatus",
"type": "String",
"selector": ["userStatus"],
"meta": {
"description": "Status of the user (e.g., 'active', 'closed')"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{userId}}",
"placeholders": [
{
"name": "userId",
"type": "String",
"description": "The ID of the user to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "groups",
"meta": {
"short": "Groups",
"description": "Manage user groups within a DocuSign account."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/groups",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "groupId",
"type": "String",
"selector": ["groupId"],
"meta": {
"description": "Unique identifier for the group"
}
},
{
"name": "groupName",
"type": "String",
"selector": ["groupName"],
"meta": {
"description": "Name of the group"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{groupId}}",
"placeholders": [
{
"name": "groupId",
"type": "String",
"description": "The ID of the group to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "folders",
"meta": {
"short": "Folders",
"description": "Manage folders for organizing envelopes."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/folders",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "folderId",
"type": "String",
"selector": ["folderId"],
"meta": {
"description": "Unique identifier for the folder"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "Name of the folder"
}
},
{
"name": "type",
"type": "String",
"selector": ["type"],
"meta": {
"description": "Type of folder (e.g., 'draft', 'inbox', 'normal')"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{folderId}}",
"placeholders": [
{
"name": "folderId",
"type": "String",
"description": "The ID of the folder to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "workspaces",
"meta": {
"short": "Workspaces",
"description": "Manage workspaces for collaboration."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/workspaces",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "workspaceId",
"type": "String",
"selector": ["workspaceId"],
"meta": {
"description": "Unique identifier for the workspace"
}
},
{
"name": "workspaceName",
"type": "String",
"selector": ["workspaceName"],
"meta": {
"description": "Name of the workspace"
}
},
{
"name": "status",
"type": "String",
"selector": ["status"],
"meta": {
"description": "Status of the workspace"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{workspaceId}}",
"placeholders": [
{
"name": "workspaceId",
"type": "String",
"description": "The ID of the workspace to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "brands",
"meta": {
"short": "Brands",
"description": "Manage account brands for styling envelopes and emails."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/brands",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "brandId",
"type": "String",
"selector": ["brandId"],
"meta": {
"description": "Unique identifier for the brand"
}
},
{
"name": "brandName",
"type": "String",
"selector": ["brandName"],
"meta": {
"description": "Name of the brand"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{brandId}}",
"placeholders": [
{
"name": "brandId",
"type": "String",
"description": "The ID of the brand to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "envelope_documents",
"meta": {
"short": "Envelope Documents",
"description": "Manage documents within a specific envelope."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
},
{
"name": "envelopeId",
"type": "String",
"description": "The ID of the envelope",
"required": true
}
]
},
"fields": [
{
"name": "documentId",
"type": "String",
"selector": ["documentId"],
"meta": {
"description": "Unique identifier for the document"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "Name of the document"
}
},
{
"name": "type",
"type": "String",
"selector": ["type"],
"meta": {
"description": "File type or document type"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{documentId}}",
"placeholders": [
{
"name": "documentId",
"type": "String",
"description": "The ID of the document to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "template_documents",
"meta": {
"short": "Template Documents",
"description": "Manage documents within a specific template."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/templates/{{templateId}}/documents",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
},
{
"name": "templateId",
"type": "String",
"description": "The ID of the template",
"required": true
}
]
},
"fields": [
{
"name": "documentId",
"type": "String",
"selector": ["documentId"],
"meta": {
"description": "Unique identifier for the document"
}
},
{
"name": "name",
"type": "String",
"selector": ["name"],
"meta": {
"description": "Name of the document"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{documentId}}",
"placeholders": [
{
"name": "documentId",
"type": "String",
"description": "The ID of the document to retrieve",
"required": true
}
]
},
"headers": {}
}
}
},
{
"handle": "signing_groups",
"meta": {
"short": "Signing Groups",
"description": "Manage signing groups for routing envelopes to a team."
},
"endpoint": {
"value": "/v2.1/accounts/{{accountId}}/signing_groups",
"placeholders": [
{
"name": "accountId",
"type": "String",
"description": "The account ID in DocuSign",
"required": true
}
]
},
"fields": [
{
"name": "signingGroupId",
"type": "String",
"selector": ["signingGroupId"],
"meta": {
"description": "Unique identifier for the signing group"
}
},
{
"name": "groupName",
"type": "String",
"selector": ["groupName"],
"meta": {
"description": "Name of the signing group"
}
}
],
"operations": {
"list": {
"method": "GET",
"path": {
"value": "",
"placeholders": []
},
"headers": {}
},
"read": {
"method": "GET",
"path": {
"value": "/{{signingGroupId}}",
"placeholders": [
{
"name": "signingGroupId",
"type": "String",
"description": "The ID of the signing group to retrieve",
"required": true
}
]
},
"headers": {}
}
}
}
]
```
Try @Human Buy @Human Subscription Join @Human Community
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.planetcrust.com/human-connections/docusign/docusign.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.