lime-crm

n8n community node for Lime CRM — work with objects, files and users, and trigger workflows on CRM events

Package Information

Released: this month
Downloads: 0 weekly / 0 monthly
Latest Version: 1.0.3
Author: Lime Technologies

Available Nodes

Documentation generating…

Lime CRM icon
Lime CRM
Consume the Lime CRM API
Lime CRM Trigger icon
Lime CRM Trigger
Trigger which handles webhooks coming from Lime, e.g when an object is updated

Documentation

@limetech/n8n-nodes-lime-crm

This is an n8n community node. It lets you use Lime CRM in your n8n workflows.

Lime CRM is a customer relationship management platform from Lime Technologies. This package lets you read and write CRM data (lime objects), work with files and users, and trigger workflows on CRM events.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources
Version history
Development

Installation

Follow the installation guide in the n8n community nodes documentation and install @limetech/n8n-nodes-lime-crm.

Operations

Lime CRM

  • Metadata: get all limetypes, get a single limetype, get file metadata.
  • Data: get many objects (with filtering, ordering and pagination), get, create, update and delete a single object, get a file, and bulk create, update or upsert many objects through the bulk-import API (requires the limepkg-mbeku-bulk-import package in the Lime CRM solution).
  • Admin: get many users, get a single user.

Lime CRM Trigger

Starts a workflow when an object of a chosen limetype is created, updated or deleted. The trigger registers a webhook subscription in Lime CRM, verifies the HMAC signature of every delivery with the webhook secret configured in the credential.

Credentials

Create a Lime CRM API credential with:

Field Description
Server URL The URL of your Lime CRM instance, e.g. https://instance.lime-crm.com/instance-name
API Key API key generated in Lime CRM (available from Lime Admin)

Requests are authenticated with the X-API-Key header, which n8n adds automatically. The credential is verified against the /api/v1/ endpoint of your instance when you save it.

To use the trigger, also set the optional Webhook Secret in the credential; Lime CRM signs deliveries with it. Use a strong value, e.g. generated with openssl rand -hex 32.

Compatibility

Requires n8n with n8n-workflow 2.9 or later. Node.js 24 is used for local development.

Usage

Lime CRM: find won deals

  1. Add a Lime CRM node and select your Lime CRM API credential.

  2. Set Resource to Data and Operation to Get Many Objects.

  3. In Limetype, pick deal (From List, or type the name with By Name).

  4. In Filter (JSON), enter a Lime Query DSL filter, for example:

    { "key": "dealstatus", "op": "=", "exp": "won" }

  5. Optionally set Limit (default 50, 0 returns all objects) and Order By.

The node outputs one item per matching object. Each item includes _id, which you can pass to Update an Object or Delete an Object in a later step. Create an Object and Update an Object take their values through Input, either as a Form mapped to the limetype's properties or as a JSON Object.

Lime CRM Trigger: react to a new deal

  1. Add a Lime CRM Trigger node. Under Events, add an event with Limetype deal and Event New (the other options are Update and Delete).
  2. Activate the workflow. The node registers a deal.new webhook subscription in Lime CRM and removes it again when the workflow is deactivated.

Each delivery becomes one item with body, headers and query. The Lime CRM event is in body: body.event is the event name (deal.new) and body.body holds the object's id, limetype and values. For example, {{ $json.body.body.id }} gives the ID of the new deal.

Resources

Version history

The full history is generated by semantic-release in CHANGELOG.md and on the GitHub releases page.

Development

npm ci
npm run build   # compile to dist/
npm test        # jest unit tests
npm run lint    # n8n community node lint rules
npm run knip    # dead code check

License

MIT

Discussion