Package Information
Documentation
eSignly n8n Node
This is the official community node for integrating eSignly with n8n. It allows you to automate electronic signatures, document conversion, template handling, and webhooks seamlessly within your n8n workflows.
Installation
To install this node in your n8n instance:
- Open your n8n instance.
- Go to Settings > Community Nodes.
- Select Install.
- Enter
n8n-nodes-esignlyand click Install.
Credentials
To use the eSignly node, you need to configure an API Key.
- Obtain your API Key from your eSignly account dashboard (Settings > API).
- In n8n, add a new eSignly Modern API credential.
- Paste your API Key. Example format:
your-api-key-here. - Select your environment:
- Live Server (acc.esignly.com): Default live instance.
- Production API (api.esignly.com): Dedicated production API server.
- QA (re-acc-go.esignly.com): Used for sandbox and testing.
- Save the credential.
Note: Do not share your API key. eSignly uses Bearer token authentication securely under the hood.
Operations
The eSignly node provides several resources and operations:
1. Contract Intelligence
- Analyze: Analyze a contract automatically.
- Preflight: Perform a preflight check on a contract.
2. Machine Evidence
- Create: Generate machine-verifiable signing evidence.
3. API Key
- Preflight: Validate the configured API key against the server.
4. Webhook
- List: Retrieve registered webhooks.
- Create: Register a new webhook endpoint.
5. Signing Request
- Get: Fetch the status of a signing request.
- List: Retrieve a list of signing requests.
- Cancel: Cancel an active signing request.
- Delete: Permanently delete a signing request.
- Download: Download the signed PDF document.
- Update Email: Change a recipient's email.
- Create: Upload a document and create a completely new signing request.
- Create From Template: Create a signing request utilizing an existing eSignly template.
6. Template
- Get: Fetch details of a specific template.
- List: Retrieve available templates.
7. Custom API Call
- Execute a custom API request against any eSignly endpoint.
File Upload
When creating a new Signing Request via Signing Request -> Create, you must provide a PDF document:
- Use a node like Read Binary File or HTTP Request (with Response Format set to File) to fetch your PDF into n8n.
- Connect it to the eSignly node.
- In the eSignly node, toggle the Input Binary Field to the correct property name (default is
data). - The node automatically translates the binary property into a
multipart/form-datapayload and uploads it securely to eSignly.
Conversion Flow
eSignly relies on an asynchronous conversion mechanism for raw document uploads. The Create operation handles this automatically via the following steps:
- Upload/Create: The node sends the PDF file to the
/signing-requestsendpoint. - Conversion Pending: The API returns a
202 Acceptedstatus . - Poll: The node automatically polls the
/document-conversions/{jobKey}endpoint in the background until the conversion status issuccess. - Key Extraction: Upon success, it extracts the generated
document_key. - Resume: The node triggers a subsequent JSON-based request to
/signing-requestspassing thedocument_key. This links the converted document to the final signing workflow instead of duplicating the document. - Final Response: Returns the completed signing request details.
Note: This two-step process is required by the API architecture. You do not need to manually manage polling; the node handles it natively during a single execution step.
JSON Examples
Some endpoints require advanced parameters such as recipients or fields formatted as JSON objects/arrays.
Recipients Example
[
{
"role": "Signer",
"name": "John Doe",
"email": "john.doe@example.com",
"kind": "signature",
"private_message": "Please sign this contract ASAP."
}
]
Fields Example
[
{
"type": "signature",
"name": "Client Signature",
"page": 1,
"x": 100,
"y": 200,
"width": 150,
"height": 50,
"required": true
}
]
These parameters can be supplied directly in the UI fields as valid JSON or injected dynamically via Expressions (e.g. {{ $json.myRecipientsArray }}).
License
MIT License