espocrm

n8n integration with EspoCRM

Package Information

Released: 4/1/2025
Downloads: 88 weekly / 338 monthly
Latest Version: 0.1.0
Author: traien

Available Nodes

EspoCRM icon
EspoCRM
Interact with EspoCRM API
EspoCRM Trigger icon
EspoCRM Trigger
Handle EspoCRM Webhooks

Documentation

@traien/n8n-nodes-espocrm

@traien/n8n-nodes-espocrm

This is a community node for n8n that enables seamless integration with EspoCRM, a powerful open-source CRM platform. With this node, you can automate your CRM operations and integrate EspoCRM with other services in your n8n workflows.

n8n is a fair-code licensed workflow automation platform.

Features

The EspoCRM node provides comprehensive access to EspoCRM's API functionality:

  • Entity Operations

    • Create new records (Leads, Contacts, Accounts, etc.)
    • Retrieve entity details
    • Update records (full or partial updates)
    • Delete records
    • List/search entities with advanced filtering

  • Dynamic Entity Support

    • Work with any entity type in your EspoCRM instance
    • Automatic field detection and validation
    • Custom field support

  • Advanced Filtering

    • Complex search queries
    • Date-based filtering
    • Relationship filters
    • Array field operations
    • Custom boolean filters

  • Performance Optimizations

    • Pagination support
    • Selective field loading
    • Skip total count for large datasets
    • Duplicate checking control

Prerequisites

  • Active EspoCRM instance (v6.0 or later recommended)
  • API access enabled in EspoCRM
  • API user with appropriate permissions
  • n8n installation (v0.170.0 or later)

Installation

Follow these steps to install this package in your n8n instance:

  1. Open your n8n instance
  2. Go to Settings > Community Nodes
  3. Select "Install"
  4. Enter @traien/n8n-nodes-espocrm
  5. Click "Install"

For a manual installation, you can use:

npm install @traien/n8n-nodes-espocrm

Or if you have installed n8n globally:

npm install -g @traien/n8n-nodes-espocrm

Configuration

API Authentication

  1. In EspoCRM:

    • Navigate to Administration > API Users
    • Create a new API User
    • Generate an API Key
    • Note down the API Key and API Secret

  2. In n8n:

    • Add new credentials of type 'EspoCRM API'
    • Enter your EspoCRM instance URL
    • Input the API Key and API Secret
    • Save the credentials

Usage Examples

Creating a Contact

Create a new contact record with customized field values:

  1. Add an "EspoCRM" node to your workflow
  2. Select "Contact" as the Resource
  3. Choose "Create" as the Operation
  4. Fill in the required fields:
    • First Name
    • Last Name
    • Email Address
  5. Add any additional fields as needed
  6. Connect to other nodes in your workflow

Working with Dynamic Entities

The Dynamic resource allows you to work with any entity type in your EspoCRM system:

  1. Add an "EspoCRM" node to your workflow
  2. Select "Dynamic" as the Resource
  3. Choose your desired Operation (Create, Update, Get, etc.)
  4. Select the Entity Type from the dropdown
  5. The available fields will be automatically loaded based on the entity type
  6. Complete the required fields and connect to your workflow

Advanced Filtering Example

{
  "operation": "getAll",
  "entityType": "Lead",
  "filterOptions": {
    "where": [
      {
        "type": "and",
        "value": [
          {
            "type": "equals",
            "field": "status",
            "value": "New"
          },
          {
            "type": "greaterThan",
            "field": "createdAt",
            "value": "2024-01-01"
          }
        ]
      }
    ],
    "orderBy": "createdAt",
    "order": "desc",
    "maxSize": 50
  }
}

Resources

Support

  • For EspoCRM-specific issues: EspoCRM Forum
  • For node-specific issues: Create an issue in the GitHub repository
  • For n8n-related questions: n8n Community

License

MIT

Discussion