n8n-espocrm

n8n-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:

• Open your n8n instance
• Go to Settings > Community Nodes
• Select "Install"
• Enter n8n-espocrm
• Click "Install"

For a manual installation, you can use:

npm install n8n-espocrm

Or if you have installed n8n globally:

npm install -g n8n-espocrm

Configuration

API Authentication

• In EspoCRM:

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

• 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:

• Add an "EspoCRM" node to your workflow
• Select "Contact" as the Resource
• Choose "Create" as the Operation
• Fill in the required fields:
  • First Name
  • Last Name
  • Email Address
• Add any additional fields as needed
• 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:

• Add an "EspoCRM" node to your workflow
• Select "Dynamic" as the Resource
• Choose your desired Operation (Create, Update, Get, etc.)
• Select the Entity Type from the dropdown
• The available fields will be automatically loaded based on the entity type
• 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

• EspoCRM API Documentation
• n8n Community Nodes Documentation

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