precisely

n8n community node for the Precisely contract automation and e-signature API

Package Information

Released: 2 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 0.1.0

Documentation

n8n-nodes-precisely

This is an n8n community node. It lets you use Precisely — a contract automation and e-signature platform — in your n8n workflows.

With it you can automate contract lifecycles: draft projects from templates, import and send documents for signing, manage signees, reviewers, reminders and metadata, and read everything back out again.

n8n is a fair-code licensed workflow automation platform.

Installation
Credentials
Operations
Usage notes
Compatibility
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

In short, on self-hosted n8n: Settings → Community Nodes → Install, then enter n8n-nodes-precisely.

Credentials

The node authenticates with a Precisely API key, sent in the X-API-KEY request header.

  1. Sign in to Precisely.
  2. Create an API token — see API tokens in Precisely.
  3. In n8n, create a new Precisely API credential and paste the token into the API Key field.

When you save the credential, n8n validates it by calling GET /organizations. All requests go to https://api.precisely.se and are rate-limited to 30 requests/minute per organization.

The API also supports JWT bearer auth via /authenticate; this node uses the API-key method only.

Operations

Nearly every operation is scoped to an Organization. The Organization field is a searchable dropdown (backed by GET /organizations); you can also switch it to By ID and enter or map an organization ID directly.

Organization
  • Get
  • Get Many
Document
  • Create (import a file from a binary field)
  • Get / Get Many
  • Search (filter by document property or metadata)
  • Update / Delete
  • Download PDF (returns a binary file)
  • Get Share Link
  • Get Many Versions / Update Version (set published state)
  • Get / Send / Cancel Signature Request
  • Send Signature Reminder
Project
  • Get / Get Many
  • Update / Delete
  • Get Approvals · Approve (Initial) · Approve (Final) · Approve (By ID) · Delete Approval
  • Get Many Documents · Create Document · Import Document
  • Send / Cancel Signature Request
  • Add Signee · Remove Signee
Template
  • Get / Get Many
  • Get Many References · Get Reference · Get Reference Options · Set Reference Options
  • Create Project (draft a project from the template)
  • Update Project
Signee (document signees)
  • Get / Get Many
  • Create · Reorder · Delete
Reviewer (document reviewers)
  • Get Many
  • Create · Delete
Reminder
  • Get Many (organization) · Get Many for Document
  • Create · Delete
Metadata Point (document metadata)
  • Get Many
  • Create · Update · Delete
Link (document links)
  • Get Many
  • Create · Delete

The node covers every endpoint in these resource areas of the Precisely public API.

Precisely Trigger

A separate Precisely Trigger node starts workflows from Precisely's resthook events. It registers a webhook subscription automatically when the workflow is activated and removes it on deactivation.

  • Trigger On events: Document Signed, Document Status Changed, User Has a Document to Sign, User Has a Document to Review, User Has a Project to Approve.
  • Verify Signature (optional): validates each delivery's Precisely-Signature header (HMAC-SHA256 over t.payload\n, keyed with the subscription's endpoint secret) and rejects mismatches with 401.

Webhook registration requires a public HTTPS callback URL — see Local development & testing.

Usage notes

  • Selecting an organization — use the From List mode to pick by name, or By ID to type/expression an ID.
  • List operations — every Get Many offers a Return All toggle and a Limit. Document and Project lists paginate server-side; the others cap the returned array client-side.
  • Importing documents — Document → Create and Project → Import Document read the file from an input binary field (default data) and upload it. Put a Read/Binary node (e.g. HTTP Request, Read Binary File) upstream.
  • Download PDF — returns the document as binary data in the field you name (default data); attach a Write Binary File or upload node downstream.
  • Delete / Cancel operations return { "deleted": true } on success.
  • Search — add Filters (document status or title) and/or Metadata Filters (metadata key + operator + value). At least one filter is required.
  • Signees, References — provided as structured, repeatable fields (add one row per signee / reference). The project Create Document Content is a free-form object, so it is entered as JSON.

Local development & testing

npm install
npm run build          # compile + copy icons/codex into dist
npm run dev            # launch local n8n with the node loaded (localhost)

To test the Precisely Trigger, Precisely needs a public HTTPS URL to call back. Use the tunnel helper, which builds the node, opens a Cloudflare quick tunnel, and starts n8n with WEBHOOK_URL pointed at it:

brew install cloudflared          # one-time
npm run dev:tunnel                # public tunnel + n8n at http://localhost:5678
# variants:
npm run dev:tunnel -- --no-tunnel                 # localhost only
WEBHOOK_URL=https://my.tunnel npm run dev:tunnel  # bring your own tunnel

Activate a workflow containing the Precisely Trigger; the node registers a subscription against Precisely with the tunnel callback URL and removes it on deactivation.

Compatibility

Requires n8n 1.60.0 or later.

Resources

Discussion