Credential Setup¶

Configure the LimeCrmApi credential before building any workflows. For credential naming standards, see Best Practices.

Lime CRM API¶

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

Required Fields¶

Field	Value	Notes
Server URL	`https://your-instance.lime-crm.com/your-database`	Include the database name. On Lime Cloud the database name matches the instance name.
API Key	From Lime Admin	See below
Webhook Secret	Auto-generated	Used to verify HMAC signatures on incoming webhooks

Where to Get the API Key¶

In Lime Admin, go to System Settings → Users & Access → Users.
Create a new API user if one does not already exist.
Select the user in the table and click Create API key.
Copy the key immediately — it cannot be retrieved again after leaving the page.

Tip

Create one API user per workflow (or per integration), and configure the correct permissions on each. For example, one user that can only create and update companies, and a separate user for creating tickets.

Note

Creating a new API key overrides any existing key on that user.

How to Configure¶

Go to Settings → Credentials → New credential.
Select Lime CRM API.
Enter the Server URL and API Key.
Click Test to verify the connection.
Save the credential.

Authentication¶

The credential injects X-API-Key: {key} on every request to the Lime CRM API.

Rate Limiting¶

Lime CRM Cloud enforces a rate limit of 3 000 requests per 5 minutes. Use bulk operations for large datasets to stay well within this limit.

Lime CRM Forms API¶

Used by the Lime CRM Forms Trigger node.

Required Fields¶

Field	Value	Notes
Server URL	`https://instance.lime-forms.com`	The base URL of your Lime Forms instance
API Key	From Lime Forms Admin	Generated under the settings page in Lime Forms Admin

How to Configure¶

Go to Settings → Credentials → New credential.
Select Lime CRM Forms API.
Enter the Server URL and API Key.
Click Test to verify the connection (it pings /api/v1/external-integrations/ping).
Save the credential.

Authentication¶

The credential authenticates with a bearer token — it injects Authorization: Bearer {key} on every request to the Lime Forms API.

Lime CRM Marketing API¶

Used by the Lime CRM Marketing node.

Required Fields¶

Field	Value	Notes
Lime CRM Marketing API URL	`https://app.bwz.se/bedrock/CUSTOMERNAME/api/`	The URL of your Lime Marketing instance. A trailing slash is stripped automatically.
API Key	From Lime Marketing	Obtained from your Lime Marketing instance

How to Configure¶

Go to Settings → Credentials → New credential.
Select Lime CRM Marketing API.
Enter the API URL and API Key.
Click Test to verify the connection (it calls GET /ping/version and confirms the response is a real Lime Marketing instance).
Save the credential.

Authentication¶

The credential injects the API key in the apikey header on every request to the Lime Marketing API.

Security Checklist¶

Never paste real API keys into workflow nodes, expressions, or sticky notes
Use a dedicated credential per environment (production, test)
Rotate API keys if there is any uncertainty about who has access to them
Store credentials only through the credential manager, never in workflow JSON files