mirror of
https://github.com/simstudioai/sim.git
synced 2026-04-06 03:00:16 -04:00
* feat(box): add Box and Box Sign integrations Add complete Box integration with file management (upload, download, get info, list folders, create/delete folders, copy, search, update metadata) and Box Sign e-signature support (create/get/list/cancel/resend sign requests). Includes OAuth provider setup, internal upload API route following the Dropbox pattern, block configurations, icon, and generated docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): address PR review comments - Fix docsLink for Box Sign: use underscore (box_sign) to match docs URL - Move normalizeFileInput from tool() to params() in Box block config to match Dropbox pattern - Throw error on invalid additionalSigners JSON instead of silently dropping signers Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): remove unsupported reason param from cancel sign request The Box Sign cancel endpoint (POST /sign_requests/{id}/cancel) does not accept a request body per the API specification. Remove the misleading reason parameter from the tool, types, block config, and docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): use canonical param ID for file normalization in params() The params function must reference canonical IDs (params.file), not raw subBlock IDs (uploadFile/fileRef) which are deleted after canonical transformation. Matches the Dropbox block pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): use generic output descriptions for shared file properties Rename "Uploaded file ID/name" to "File ID/name" in UPLOAD_FILE_OUTPUT_PROPERTIES since the constant is shared by both upload and copy operations. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): rename items output to entries for list_folder_items Rename the output field from "items" to "entries" to match Box API naming and avoid collision with JSON schema "items" keyword that prevented the docs generator from rendering the nested array structure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): filter empty file IDs from sourceFileIds input Add .filter(Boolean) after splitting sourceFileIds to prevent empty strings from trailing/double commas being sent as invalid file IDs to the Box Sign API. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(box): merge Box Sign into single Box block Combine Box and Box Sign into one unified block with all 15 operations accessible via a single dropdown, removing the separate box_sign block. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): filter empty strings from tags array in update_file Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * style(docs): apply lint formatting to icon-mapping and meta.json Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * style(box): format chained method calls per linter rules Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * style(box,docusign): set block bgColor to white and regenerate docs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * style(docs): apply lint formatting Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): populate OAuth scopes for Box since token response omits them Box's OAuth2 token endpoint does not return a scope field in the response, so Better Auth stores nothing in the DB. This causes the credential selector to always show "Additional permissions required". Fix by populating the scope from the requested scopes in the account.create.before hook. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(box): add sign_requests.readwrite scope for Box Sign operations Box Sign API requires the sign_requests.readwrite scope in addition to root_readwrite. Without it, sign requests fail with "The request requires higher privileges than provided by the access token." Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * update docs --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
231 lines
8.9 KiB
Plaintext
231 lines
8.9 KiB
Plaintext
---
|
|
title: DocuSign
|
|
description: Send documents for e-signature via DocuSign
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="docusign"
|
|
color="#FFFFFF"
|
|
/>
|
|
|
|
{/* MANUAL-CONTENT-START:intro */}
|
|
[DocuSign](https://www.docusign.com) is the world's leading e-signature platform, enabling businesses to send, sign, and manage agreements digitally. With its powerful eSignature REST API, DocuSign supports the full document lifecycle from creation through completion.
|
|
|
|
With the DocuSign integration in Sim, you can:
|
|
|
|
- **Send envelopes**: Create and send documents for e-signature with custom recipients and signing tabs
|
|
- **Use templates**: Send envelopes from pre-configured DocuSign templates with role assignments
|
|
- **Track status**: Get envelope details including signing progress, timestamps, and recipient status
|
|
- **List envelopes**: Search and filter envelopes by date range, status, and text
|
|
- **Download documents**: Retrieve signed documents as base64-encoded files
|
|
- **Manage recipients**: View signer and CC recipient details and signing status
|
|
- **Void envelopes**: Cancel in-progress envelopes with a reason
|
|
|
|
In Sim, the DocuSign integration enables your agents to automate document workflows end-to-end. Agents can generate agreements, send them for signature, monitor completion, and retrieve signed copies—powering contract management, HR onboarding, sales closings, and compliance processes.
|
|
{/* MANUAL-CONTENT-END */}
|
|
|
|
|
|
## Usage Instructions
|
|
|
|
Create and send envelopes for e-signature, use templates, check signing status, download signed documents, and manage recipients with DocuSign.
|
|
|
|
|
|
|
|
## Tools
|
|
|
|
### `docusign_send_envelope`
|
|
|
|
Create and send a DocuSign envelope with a document for e-signature
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `emailSubject` | string | Yes | Email subject for the envelope |
|
|
| `emailBody` | string | No | Email body message |
|
|
| `signerEmail` | string | Yes | Email address of the signer |
|
|
| `signerName` | string | Yes | Full name of the signer |
|
|
| `ccEmail` | string | No | Email address of carbon copy recipient |
|
|
| `ccName` | string | No | Full name of carbon copy recipient |
|
|
| `file` | file | No | Document file to send for signature |
|
|
| `status` | string | No | Envelope status: "sent" to send immediately, "created" for draft \(default: "sent"\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `envelopeId` | string | Created envelope ID |
|
|
| `status` | string | Envelope status |
|
|
| `statusDateTime` | string | Status change datetime |
|
|
| `uri` | string | Envelope URI |
|
|
|
|
### `docusign_create_from_template`
|
|
|
|
Create and send a DocuSign envelope using a pre-built template
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `templateId` | string | Yes | DocuSign template ID to use |
|
|
| `emailSubject` | string | No | Override email subject \(uses template default if not set\) |
|
|
| `emailBody` | string | No | Override email body message |
|
|
| `templateRoles` | string | Yes | JSON array of template roles, e.g. \[\{"roleName":"Signer","name":"John","email":"john@example.com"\}\] |
|
|
| `status` | string | No | Envelope status: "sent" to send immediately, "created" for draft \(default: "sent"\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `envelopeId` | string | Created envelope ID |
|
|
| `status` | string | Envelope status |
|
|
| `statusDateTime` | string | Status change datetime |
|
|
| `uri` | string | Envelope URI |
|
|
|
|
### `docusign_get_envelope`
|
|
|
|
Get the details and status of a DocuSign envelope
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `envelopeId` | string | Yes | The envelope ID to retrieve |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `envelopeId` | string | Envelope ID |
|
|
| `status` | string | Envelope status \(created, sent, delivered, completed, declined, voided\) |
|
|
| `emailSubject` | string | Email subject line |
|
|
| `sentDateTime` | string | When the envelope was sent |
|
|
| `completedDateTime` | string | When all recipients completed signing |
|
|
| `createdDateTime` | string | When the envelope was created |
|
|
| `statusChangedDateTime` | string | When the status last changed |
|
|
| `voidedReason` | string | Reason the envelope was voided |
|
|
| `signerCount` | number | Number of signers |
|
|
| `documentCount` | number | Number of documents |
|
|
|
|
### `docusign_list_envelopes`
|
|
|
|
List envelopes from your DocuSign account with optional filters
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `fromDate` | string | No | Start date filter \(ISO 8601\). Defaults to 30 days ago |
|
|
| `toDate` | string | No | End date filter \(ISO 8601\) |
|
|
| `envelopeStatus` | string | No | Filter by status: created, sent, delivered, completed, declined, voided |
|
|
| `searchText` | string | No | Search text to filter envelopes |
|
|
| `count` | string | No | Maximum number of envelopes to return \(default: 25\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `envelopes` | array | Array of DocuSign envelopes |
|
|
| ↳ `envelopeId` | string | Unique envelope identifier |
|
|
| ↳ `status` | string | Envelope status \(created, sent, delivered, completed, declined, voided\) |
|
|
| ↳ `emailSubject` | string | Email subject line |
|
|
| ↳ `sentDateTime` | string | ISO 8601 datetime when envelope was sent |
|
|
| ↳ `completedDateTime` | string | ISO 8601 datetime when envelope was completed |
|
|
| ↳ `createdDateTime` | string | ISO 8601 datetime when envelope was created |
|
|
| ↳ `statusChangedDateTime` | string | ISO 8601 datetime of last status change |
|
|
| `totalSetSize` | number | Total number of matching envelopes |
|
|
| `resultSetSize` | number | Number of envelopes returned in this response |
|
|
|
|
### `docusign_void_envelope`
|
|
|
|
Void (cancel) a sent DocuSign envelope that has not yet been completed
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `envelopeId` | string | Yes | The envelope ID to void |
|
|
| `voidedReason` | string | Yes | Reason for voiding the envelope |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `envelopeId` | string | Voided envelope ID |
|
|
| `status` | string | Envelope status \(voided\) |
|
|
|
|
### `docusign_download_document`
|
|
|
|
Download a signed document from a completed DocuSign envelope
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `envelopeId` | string | Yes | The envelope ID containing the document |
|
|
| `documentId` | string | No | Specific document ID to download, or "combined" for all documents merged \(default: "combined"\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `base64Content` | string | Base64-encoded document content |
|
|
| `mimeType` | string | MIME type of the document |
|
|
| `fileName` | string | Original file name |
|
|
|
|
### `docusign_list_templates`
|
|
|
|
List available templates in your DocuSign account
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `searchText` | string | No | Search text to filter templates by name |
|
|
| `count` | string | No | Maximum number of templates to return |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `templates` | array | Array of DocuSign templates |
|
|
| ↳ `templateId` | string | Template identifier |
|
|
| ↳ `name` | string | Template name |
|
|
| ↳ `description` | string | Template description |
|
|
| ↳ `shared` | boolean | Whether template is shared |
|
|
| ↳ `created` | string | ISO 8601 creation date |
|
|
| ↳ `lastModified` | string | ISO 8601 last modified date |
|
|
| `totalSetSize` | number | Total number of matching templates |
|
|
| `resultSetSize` | number | Number of templates returned in this response |
|
|
|
|
### `docusign_list_recipients`
|
|
|
|
Get the recipient status details for a DocuSign envelope
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `envelopeId` | string | Yes | The envelope ID to get recipients for |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `signers` | array | Array of DocuSign recipients |
|
|
| ↳ `recipientId` | string | Recipient identifier |
|
|
| ↳ `name` | string | Recipient name |
|
|
| ↳ `email` | string | Recipient email address |
|
|
| ↳ `status` | string | Recipient signing status \(sent, delivered, completed, declined\) |
|
|
| ↳ `signedDateTime` | string | ISO 8601 datetime when recipient signed |
|
|
| ↳ `deliveredDateTime` | string | ISO 8601 datetime when delivered to recipient |
|
|
| `carbonCopies` | array | Array of carbon copy recipients |
|
|
| ↳ `recipientId` | string | Recipient ID |
|
|
| ↳ `name` | string | Recipient name |
|
|
| ↳ `email` | string | Recipient email |
|
|
| ↳ `status` | string | Recipient status |
|
|
|
|
|