Skip to content

Getting Started

Workflows is designed for event-driven reactions — something happens in Lime CRM, and Workflows responds. This can mean calling an external API, syncing data with another system, enriching a record, creating related records, or running AI. Use Lime (Python code or Automations) when logic must execute as part of saving a record; use Workflows when it can run after the event fires.

Prerequisites

Before you begin you need:

  • Access to a workflow tool instance (ask your Lime consultant or administrator)
  • A Lime CRM API key (see Credential Setup)

Configure Your Credential

  1. Open Settings → Credentials → New credential and select Lime CRM API.
  2. Enter the Server URL — your Lime CRM URL including the database name, for example https://acme.lime-crm.com/acmedb. On Lime Cloud, the database name is the same as the instance name.
  3. Enter your API Key from Lime Admin.
  4. Click Test to verify the connection, then save the credential.

See Credential Setup for full details and Best Practices for how to name it.

Key Concepts

Trigger Payload

The Lime CRM Trigger delivers the full object on every event:

  • new events — values contains all current field values.
  • update events — values contains all current field values. original_values contains the previous values of any fields that changed, so you can detect exactly what was updated.
  • delete events — body contains the id and limetype of the deleted record.

Expressions

Use {{ expression }} syntax to reference data from earlier nodes:

Goal Expression
Field value from trigger {{ $json.body.body.values.fieldName }}
Record ID from trigger {{ $json.body.body.id }}
Previous value of a changed field {{ $json.body.body.original_values.fieldName }}
Output from a named node {{ $('Node name').item.json.fieldName }}

Test vs Production

  • Use Listen for test event and Test workflow during development.
  • Toggle Active only when you are ready to go live.
  • Node changes take effect on the next execution, not the current one.

Next Steps