n8n-nodes-estiwise

This is an n8n community node package that provides integration with the EstiWise API.

n8n is a fair-code licensed workflow automation platform.

Table of Contents

• Installation
• Credentials
• Nodes
  • EstiWise Customer
  • EstiWise Knowledge Base
• Compatibility
• Usage
• Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Community Nodes (n8n.io and npm)

1. Go to Settings > Community Nodes.
2. Select Install.
3. Enter n8n-nodes-estiwise in Enter npm package name.
4. Agree to the risks of using community nodes: select I understand the risks of installing unverified code from a public source.
5. Select Install.

After installing the node, you can use it like any other node. n8n displays the node in search results in the Nodes panel.

Local Development

For local development or testing:

# Clone the repository
git clone https://github.com/commitsmart/n8n-nodes-estiwise.git
cd n8n-nodes-estiwise

# Install dependencies
npm install

# Build the project
npm run build

# Link to your n8n installation
npm link
cd ~/.n8n/custom
npm link n8n-nodes-estiwise

# Restart n8n

Credentials

This package provides one credential type:

EstiWise API

To use this node, you need to set up EstiWise API credentials:

1. Environment: Choose between Production or Staging

   • Production: https://api.estiwise.ai
   • Staging: https://api.staging.estiwise.ai

2. API Key: Your EstiWise API key (sent as X-Api-Key header)

3. Tenant ID: Your EstiWise tenant identifier (sent as X-JWT-Tenant header)

The credential automatically tests the connection by attempting to list customers.

Nodes

EstiWise Customer

Manage customers in your EstiWise CRM.

Operations

• Create: Create a new customer

  • Required: First Name, Last Name, Email
  • Optional: Phone Number, Region, Country

• Get: Retrieve a single customer by ID

  • Required: Customer ID

• Get Many: List customers with pagination and filters

  • Pagination: Limit, Page Index
  • Sorting: Order By (field name), Order (ASC/DESC)
  • Filters: Search, Favorites Only, Region, Date Range

• Update: Update an existing customer

  • Required: Customer ID, First Name, Last Name, Email
  • Optional: Phone Number, Region, Country

• Delete: Delete a customer

  • Required: Customer ID

Example Usage

Create a Customer:

{
  "operation": "create",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "phoneNumber": "+14155552671",
  "region": "region-id",
  "country": "country-id"
}

List Customers:

{
  "operation": "getAll",
  "limit": 20,
  "pageIndex": 0,
  "orderBy": "createdAt",
  "order": "DESC",
  "additionalFields": {
    "search": "john",
    "favoritesOnly": false
  }
}

EstiWise Knowledge Base

Manage documents in your EstiWise Knowledge Base.

Operations

• Upload Document: Upload a file to the knowledge base

  • Required: Binary Property Name, Document Name
  • Optional: Description
  • Supported formats: PDF, DOCX, DOC, PNG, JPEG, TXT, CSV

• Delete Document: Remove a document from the knowledge base

  • Required: Document ID

• Get Document: Retrieve document details

  • Required: Document ID

• List Documents: List all documents with filters

  • Pagination: Limit, Page
  • Filters: Status (UPLOADED, SCANNING, VALIDATING, PROCESSING, COMPLETED, FAILED)

Example Usage

Upload a Document:

1. Use a Read Binary File node or HTTP Request node to get the file
2. Connect to EstiWise Knowledge Base node
3. Configure:
   • Operation: Upload Document
   • Binary Property: data (default from file read)
   • Document Name: Requirements Document
   • Description: Q1 2024 project requirements

List Documents:

{
  "operation": "getAll",
  "returnAll": false,
  "limit": 20,
  "additionalFields": {
    "status": "COMPLETED",
    "page": 1
  }
}

Compatibility

• Tested with n8n version 1.0.0+
• Requires Node.js 18.0.0 or higher

Usage

Workflow Example: Customer Onboarding

Webhook (Trigger)
  ↓
EstiWise Customer (Create)
  ↓
EstiWise Knowledge Base (Upload Document - if file provided)
  ↓
Send Email (Confirmation)

Workflow Example: Document Processing Status

Schedule Trigger (Every 5 minutes)
  ↓
EstiWise Knowledge Base (List Documents - status=PROCESSING)
  ↓
IF Node (Check if processing > 10 minutes)
  ↓
Send Alert (Slack/Email)

Resources

• n8n community nodes documentation
• EstiWise API Documentation
• EstiWise Website

Development

Build

npm run build

Lint

npm run lint
npm run lint:fix

Format

npm run format

License

MIT

Support

For support with this node package:

• Create an issue in the GitHub repository
• Contact [email protected]

For EstiWise API support:

• Visit https://estiwise.ai/support

CommIT Smart since 2018