Lime n8n Nodes

This repository contains @limetech/n8n-nodes-lime — a community node package that connects n8n to Lime services: Lime CRM, Lime Forms, and Lime Marketing.

Full node reference (all actions, parameters, and examples) is available in the official documentation: https://platform.docs.lime-crm.com/en/latest/workflows-and-integrations/node-reference/

Installation

Install the package as a community node in your n8n instance:

1. In n8n, go to Settings → Community Nodes
2. Select Install a community node
3. Enter @limetech/n8n-nodes-lime and confirm

See the n8n community nodes documentation for details, including installation on self-hosted instances via N8N_COMMUNITY_PACKAGES.

Included Nodes

| Node | Type | Description | | -------------------------- | ------- | ------------------------------------------------------------------------------------- | | Lime CRM | Action | Read and write Lime CRM data (objects, files, limetypes, users) | | Lime CRM Trigger | Trigger | Starts a workflow when an object of a chosen limetype is created, updated, or deleted | | Lime CRM Forms | Action | Retrieve receipt PDFs for form submissions | | Lime CRM Forms Trigger | Trigger | Starts a workflow when a monitored Lime Forms form receives a submission | | Lime CRM Marketing | Action | Send transactional email and SMS via Lime Marketing |

Lime CRM node operations

• Metadata: get all limetypes, get a single limetype, get file metadata
• Data: get many objects (with filtering and pagination), get/create/update/delete a single object, get a file, bulk create/update/upsert many objects
• Admin: get many users, get a single user

Lime CRM Forms node operations

• Receipt: get a receipt PDF (submission or signing)

Lime CRM Marketing node operations

• Transactional Email: send
• Transactional SMS: send

Authentication

Each service uses its own credential type in n8n. Create credentials under Credentials → Add credential and search for the credential name below. All credentials are verified against your instance when you save them.

Lime CRM API

Used by the Lime CRM node and Lime CRM Trigger.

| 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.

Lime CRM Forms API

Used by the Lime CRM Forms node and Lime CRM Forms Trigger.

| Field | Description | | ---------- | --------------------------------------------------------------------------------- | | Server URL | The URL of your Lime Forms instance, e.g. https://instance.lime-forms.com | | API Key | API key generated in Lime Forms (available in the Lime Forms admin settings page) |

Requests are authenticated with a Authorization: Bearer <token> header, which n8n adds automatically.

Lime CRM Marketing API

Used by the Lime CRM Marketing node.

| Field | Description | | -------------------------- | ------------------------------------------------------------------------------------------------ | | Lime CRM Marketing API URL | The API URL of your Lime Marketing instance, e.g. https://app.bwz.se/bedrock/CUSTOMERNAME/api/ | | API Key | API key obtained from Lime Marketing |

Requests are authenticated with the apikey header, which n8n adds automatically.

Example Workflows

Notify on new companies in Lime CRM

1. Add a Lime CRM Trigger node, select your Lime CRM API credential, and add an event: limetype company, event New.
2. Connect a Slack (or email) node and compose a message from the trigger output, e.g. {{ $json.name }}.
3. Activate the workflow — Lime CRM will call the generated webhook whenever a company is created.

Sync form submissions into Lime CRM

1. Add a Lime CRM Forms Trigger node, select your Lime Forms API credential, and pick the form to monitor.
2. Connect a Lime CRM node with resource Data and operation Create Single Object, and map submission fields to limetype properties.
3. Activate the workflow — every submission creates an object in Lime CRM.

Send a transactional email

1. Start from any trigger (e.g. a Webhook or Lime CRM Trigger).
2. Add a Lime CRM Marketing node with resource Transactional Email and operation Send, select your Lime Marketing API credential, and fill in the recipient and template fields.

More examples and per-action documentation: https://platform.docs.lime-crm.com/en/latest/workflows-and-integrations/node-reference/

Development

Local development is done via a DevContainer.

Prerequisites

• Docker (Rancher Desktop)
• VS Code + the “Dev Containers” extension

Getting Started (Dev Container)

1. Open this repo in VS Code
2. Run: “Dev Containers: Reopen in Container”

On first create, the Dev Container will:

• run npm ci
• build the package (npm run build)
• restart the n8n container so it picks up the compiled dist/ output

When the container is up, n8n is available at:

• http://localhost:5678

Development Workflow

• Build once: npm run build
• Watch TypeScript: npm run dev
• Run tests: npm test
• Lint: npm run lint

If you rebuild and need n8n to reload the updated custom nodes, restart n8n from inside the Dev Container:

docker restart n8n

Useful commands while developing:

# Follow n8n logs
docker logs -f n8n

# Stop/start n8n
docker stop n8n
docker start n8n

How the Custom Nodes Are Loaded

The Dev Container composition runs two services:

• devcontainer: your Node.js (Node 24) development environment
• n8n: an n8n instance configured to load custom extensions

The compiled output in dist/ is mounted into the n8n container and exposed to n8n via N8N_CUSTOM_EXTENSIONS.

n8n state is persisted in a named Docker volume (n8n-data) managed by the Dev Container composition.

Requirement of restart of dev env

During development, you will have to restart development n8n server because of how n8n actually loads nodes:

• Custom nodes are loaded once at startup

• Node metadata (description, properties, inputs/outputs) is cached

• Executions reuse the already-loaded JS code

• So n8n must be restarted to see changes in:

  • description
  • properties
  • credentials definitions
  • icons, display options, etc.

• This is true for:

  • custom nodes in ~/.n8n/nodes and ~/.n8n/custom
  • nodes baked into a Docker image
  • community nodes

If you rebuild and need n8n to reload the updated custom nodes, restart n8n from terminal:

docker restart n8n

Troubleshooting

• If npm ci fails due to permissions on node_modules, rebuild the container (the Dev Container uses a named volume for node_modules).
• If n8n starts but the nodes don’t show up, ensure you’ve run npm run build and then docker restart n8n.

References

• n8n node authoring docs: https://docs.n8n.io/integrations/creating-nodes/
• n8n verification guidelines: https://docs.n8n.io/integrations/creating-nodes/build/reference/verification-guidelines/

No devcontainers?

Just run docker-compose up - the rest is similar to work with devcontainer.