Submit a ticket
Welcome
Login

Lime CRM Configuration

Navigate this guide based on your role

Changelog

v1.1.2

Released: 2025-07-07

New Features

  • Authentication module: Connects Lime CRM to Oneflow
    • Lime CRM URL and
    • Lime CRM API token validation.
  • Create Oneflow documents from Lime deals.
    • Add Lime CRM contacts and companies as participants.
    • Sync Oneflow document status to Lime.
  • View Oneflow Documents from Lime CRM Deals
    • All Oneflow documents (Draft, Pending, Overdue, Signed, and Declined) are shown in the “Oneflow documents” tab of each Deal.
    • Clicking on a document shows its status and participant details.

Index: Overview

This integration connects Oneflow with Lime CRM, enabling sales teams to automate and manage contract documents directly within their CRM environment. It reduces manual work, enhances accuracy, and accelerates sales cycles.

Features

  • Automatically create Oneflow documents from Lime CRM deals.
  • Add Lime CRM contacts associated with the deal as counterparties to the Oneflow document.
  • Track the status of Oneflow documents directly within Lime CRM.
  • View signed documents directly from Lime CRM deals.
  • Streamlined user interface for contract document creation.

End-user contacts Lime CRM to activate the integration

  • The end-user needs to to contact Lime Technologies and request the installation of the Oneflow integration via the Contact sales page.
  • The Lime CRM administrator needs to perform the configurations outlined in this guide for their Lime CRM instance. See Configuration for more information.

How it Works

Oneflow Document Creation

  • Users can create Oneflow documents directly from Lime CRM by opening a deal and clicking the “Oneflow document” button which launches the Oneflow document creation window.

  • The integration seamlessly guides the user through selecting a workspace, choosing a template, and adding counterparties (contacts) to create and send the Oneflow document.

Contacts to Counterparties

  • Contacts associated with the deal can be added as counterparties in the Oneflow document. Users can add multiple counterparties in one step.

Oneflow Document Status Sync

  • Oneflow documents created from a Lime CRM deal are displayed in cards within the “Oneflow documents” tab of the Deal.

    • Draft, Pending, Overdue, Signed, and Declined Oneflow documents are listed.

    • Clicking on a Oneflow document name reveals its status, and created/updated dates, along with the participant details (such as participant names, participant type, and their role in the document).

  • Once the Oneflow document is sent to participants, the Oneflow document’s status is updated inside the card of the Lime CRM deal. This allows for at-a-glance visibility of document progress.

Requirements

  1. Lime CRM web client.

  2. If Lime CRM is on-premise: Internet access for outgoing traffic and for incoming traffic to the Lime CRM API.

  3. If cloud with customizations or on-premise: Packages limepkg-option-visualizer and limepkg-status-flow need to be included in the solution.

  4. An active Oneflow subscription.

  5. Tables and properties for oneflowdocument and oneflowdocumentparticipant must exist within Lime CRM for the integration to work properly. See Table and Field Definitions Lime CRM for attribute details. These limetypes are expected to exist for the integration to work.

Note:

The two tables must be named in the Database Designer exactly as specified (oneflowdocument and oneflowdocumentparticipant) with no spaces or deviations. This is because the integration is hardcoded to reference these exact table names. Failure to follow this naming convention will result in the integration not functioning properly.

Technical Details

Oneflow and Lime REST API integrations

  • Use of standard Lime Lime CRM frontend configuration for the UI parts inside Lime CRM.

Lime types:

Two new tables need to be created in the Database Designer:

  1. Oneflowdocument
  2. Oneflowdocumentparticipant

See Table and Field Definitions Lime CRM for attribute details.

  • Oneflow Document (table name: oneflowdocument): A custom object to represent documents managed by Oneflow within Lime CRM. This object would store document details and status.
  • Oneflow Document Participant (table name: oneflowdocumentparticipant): A custom object to represent participants involved in Oneflow documents. This object would store participant details, roles, and statuses.

API Endpoints:

  • Oneflow Document Endpoints: Custom endpoints for managing Oneflow documents within Lime CRM, such as creating, updating, and deleting documents.
  • Oneflow Participant Endpoints: Custom endpoints for managing participants associated with Oneflow documents, including adding, updating, and retrieving participant information.

Lime CRM API and Webhook Usage

For Oneflow document creation with participants:

  • Core
    • GET /api/v1/
    • GET /api/v1/limeobject/{object_type}/{id}/
  • Deal
    • GET /api/v1/limeobject/deal/{id}/
  • Person
    • GET /api/v1/limeobject/person/{id}/
  • Company
    • GET /api/v1/limeobject/company/{id}/person/
  • oneflowdocument
    • GET /api/v1/limeobject/oneflowdocument/
    • POST /api/v1/limeobject/oneflowdocument/
    • PUT /api/v1/limeobject/oneflowdocument/{id}/
    • DELETE /api/v1/limeobject/oneflowdocument/{id}/
    • GET /api/v1/limeobject/oneflowdocument/{id}/oneflowdocumentparticipant/
  • oneflowdocumentparticipant
    • POST /api/v1/limeobject/oneflowdocumentparticipant/
    • PUT /api/v1/limeobject/oneflowdocumentparticipant/{id}/
  • Coworker
    • GET /api/v1/limeobject/coworker/{id}/
  • Subscription
    • GET /api/v1/subscription/{id}/
    • POST /api/v1/subscription/
    • PUT /api/v1/subscription/{id}/

For Lime CRM authentication:

  • GET /check_valid_token/
  • POST /create_lime_subscription/
  • GET /get_lime_subscription/{subscription_id}/
  • PUT /update_lime_subscription/{subscription_id}/

For Document status tracking: Webhooks and Lime visual progress field

Configuration

Add the “Oneflow document” button to the deal view

  1. Navigate to Administrators page > Views > Deal
  2. Under Promoted actions, click on the + Promoted actions button to add a new one.
  3. Complete the form with the following fields.
    1. Command id: Open link (Standard actions)

    2. Action label: “Oneflow document”

    3. Icon: add_file

    4. Color: #013A4C

    5. Parameters: Enter the following code.

      
      {
        "nextCommand": {
          "params": {}
        },
        "link": {
          "expectedOutputType": "auto",
          "formula": "https://integrations.oneflow.com/api/lime_crm/generate_token?object_type=deal&object_id={{id}}&user_email={{context.active_user.email | urlencode}}&user_id={{context.active_user.id}}"
        },
        "openInNewTab": true,
        "type": "url",
        "confirm": {
          "options": {}
        }
      }
              

      Config:

      Link:

      1. Value type: Formula

      2. Expected output type: Auto

      3. Formula:

        https://integrations.oneflow.com/api/lime_crm/generate_token?object_type=deal&object_id={{id}}&user_email={{context.active_user.email | urlencode}}&user_id={{context.active_user.id}}
                    
    6. Open in new tab: Enable this checkbox if you want the Oneflow app to load in a different tab to your Lime CRM deal.

    7. Type: URL

  4. Save the promoted action button. A “Create Oneflow document” button will be added to your Deal view in Lime CRM.

Installation Instructions

To use the Oneflow x Lime CRM integration, you will need to connect your Oneflow account to Lime CRM. This requires Lime CRM administrator access to generate a Lime CRM API key.

Prerequisites

Ensure the following requirements are met.

  • Administrator access to Lime CRM and Oneflow.
  • Contacted Lime CRM’s support team to activate the Oneflow integration for Lime CRM as specified in Index: Overview.
  • Ensure the Lime CRM user belongs to the “Webhook Users” group with the type set to “API”.
  • Add translations for all newly created limetypes and properties in Lime CRM to English, Swedish, Danish, Norwegian, Finnish, German, and Dutch during installation, as these are not bundled in a Lime package.

Lime CRM: Configure permissions and generate an API key

This ensures that Oneflow has the necessary permissions to access entities in your Lime CRM account.

  1. Login to Lime CRM as an admin and click Account and select the Administrators page.

  2. Navigate to System > Security > Users

  3. Create a new user (or update an existing user) with these properties. This is applicable to all users that need to use the Oneflow integration.

    For the admin user (this should be the Lime CRM user whose email address matches the one registered as the account owner in Oneflow):

    1. Username: Enter the email of the user

    2. Display name: Enter a preferred display name

    3. User type: Select “API”.

    4. Groups: Select “Webhook Users” and “System (Oneflow) integration”

      Information:
      • Create the user group if it does not exist and ensure the group has the permissions specified in the Setting Permissions section.
      • Ensure the API user is a member of both groups: Webhook Users and System (Oneflow) integration.
  4. Select the user using the checkbox, then click Create API key and click Generate. Click Copy to clipboard and save this API key securely in your system as you will need this to connect Oneflow to Lime CRM.

Setting Permissions

Use the Lime CRM Server Administrator to assign permissions to the user group: System (Oneflow) integration.

Specify the following permissions explicitly for each Lime type:

Lime TypeGET (Read)PUT (Write)POST (Create)DELETE (Delete)
Deal
Company
Person
Coworker
Oneflow Document
Oneflow Document Participant

Connecting Lime CRM to Oneflow

  1. Login to Oneflow as an administrator and navigate to the Oneflow marketplace and click on Lime CRM.

  2. Locate and enable the Lime CRM extension.

  3. Click on the Setup button. This will launch the Oneflow Lime integration setup.

  4. Enter your Lime host URL and Lime API key and click Connect.

    1. Lime CRM URL: Enter the main URL that you use to login to Lime CRM containing your organization’s name.

      To know your Lime CRM URL, login to Lime CRM and go to Account > Administrators page > and copy the URL section along with the client name. 

      Example: In this case, the Lime host URL is http://oneflow.lime-crm.com/oneflow.

    2. Lime API key: The API key that was generated for the dedicated API user for the Oneflow integration in the administrator’s page of Lime CRM.

Note:
Ensure that you have added the promoted action button as specified in Configuration.

Technical Configuration

Scope

Each of the following areas requires multiple configuration settings, including changes in the Lime CRM Database Designer.

  1. Lime CRM Database Designer configuration
  2. Lime CRM Administrator page: View configuration
  3. Lime CRM Administrator page: System configuration

1. Lime database configurations

Two new tables need to be created in the Database Designer:

  1. Oneflowdocument
  2. Oneflowdocumentparticipant
  • “oneflow document participants” need to be added to the Oneflow document table as a relation field (foreign key).
  • “Deal” needs to be added to the oneflowdocument table as a relation field (foreign key).
  • “oneflow document” needs to be added to the oneflowdocumentparticipant table as a relation field (foreign key).
  • “oneflowdocuments" and oneflowdocumentparticipant” need to be added to the deal table as a relation field (foreign key).
Note:

The two tables must be named in the Database Designer exactly as specified (oneflowdocument and oneflowdocumentparticipant) with no spaces or deviations. This is because the integration is hardcoded to reference these exact table names. Failure to follow this naming convention will result in the integration not functioning properly.

Table and Field Definitions Lime CRM

1. Table oneflowdocument

  • Display name: Oneflow document
  • Display name (plural): Oneflow documents

Columns

name

  • Display name: Oneflow document name
  • Field type: Text
  • Length: 128
  • Null permitted: False
  • Required: True

createdinoneflow

  • Display name: Created
  • Field type: Time
  • Null permitted: True
  • Required: False

updatedinoneflow

  • Display name: Updated
  • Field type: Time
  • Null permitted: True
  • Required: False

oneflowstatus

  • Display name: Status
  • Field type: Option
  • Default value: Draft
  • Options:
    • draft: Draft
    • pending: Pending
    • overdue: Overdue
    • signed: Signed
    • declined: Declined
    • delivery_failed: Delivery Failed
  • Null permitted: False
  • Required: False

deal

  • Display name: Deal
  • Field type: Relation (to the deal)
  • Null permitted: True

open

  • Display name: Open in Oneflow
  • Type: WWW
  • Field type: Link
  • Null permitted: False
  • Required: False

key_event

  • Display name: Key event
  • Field type: Text
  • Null permitted: False
  • Required: False

latest_activity

  • Display name: Latest activity
  • Field type: Text
  • Null permitted: False
  • Required: False

oneflow_document_id

  • Display name: oneflow document_id (because not shown in the UI)
  • Field type: Integer
  • Type: Standard
  • Null permitted: False
  • Required: True

oneflow_document_link

  • Display name: oneflow document link
  • Field type: Link
  • Type: WWW
  • Null permitted: False
  • Required: False

oneflowdocumentparticipant

  • Display name: Document participants
  • Field type: Relation
  • Null permitted: True

2. Table oneflowdocumentparticipant

  • Display name: Document participant
  • Display name (plural): Document participants
  • Invisible: Yes

Columns

name

  • Display name: Participant name
  • Field type: Text
  • Length: 128
  • Null permitted: False
  • Required: True

role

  • Display name: Role in document
  • Field type: Option
  • Default value: <space>
  • Options:
    • empty: <space>
    • viewer: Viewer
    • internalapprover: Internal approver
    • influencer: Influencer
    • signatory: Signatory
  • Null permitted: False
  • Type: Color and Text
  • Required: True

signstatus

  • Display name: Sign status
  • Field type: Option
  • Default value: <space>
  • Options:
    • empty: <space>
    • signed: Signed
    • pending: Pending
    • approved: Approved
    • declined: Declined
  • Null permitted: False
  • Type: Color and Text
  • Required: False

views

  • Display name: eye Views (yes including the eye emoji)
  • Field type: Integer
  • Type: Standard
  • Null permitted: False
  • Required: False

oneflowdocument

  • Display name: Oneflow document
  • Field type: Relation
  • Null permitted: True

company_individual

  • Display name: Company/Individual
  • Field type: Text
  • Length: max
  • Null permitted: False
  • Required: True

email

  • Display name: Email
  • Field type: Text
  • Length: max
  • Null permitted: False
  • Required: False

2. Lime administrator page: View configurations

Goal: Add a “Oneflow documents” tab to the deal view and the “Oneflow document” promoted action button.
  1. You need to add a separate tab called “Oneflow documents” to the deal view in Lime CRM.
  2. You need to add the “Oneflow document” promoted action button.

2.1 Deal

Promoted Action

  • Type: Formula
  • Formula:
https://integrations.oneflow.com/api/lime_crm/generate_token?object_type=deal&object_id={{id}}&user_email={{context.active_user.email | urlencode}}&user_id={{context.active_user.id}}

Tabs

  • oneflowdocument
    • Standard tabs
    • Standard: Oneflow documents

Activities

  1. Login to Lime CRM as an admin and click Account and select the Administrators page.
  2. Navigate to Views > Deal > Activities.
  3. Click + Add to add a new section.
  4. Select Oneflow documents from the dropdown.
  5. Click + Add to add a new section.
  6. Select Oneflow documents from the first dropdown, then select Oneflow document participants from the second dropdown.
  7. Click Save.

Alternatively, add the following code block under the “relations” block.

   {  
    "relation": "document"  
    },
    {  
     "relation": "oneflowdocument"  
    },  
    {  
     "relation": oneflowdocument.oneflowdocumentparticipant"  
    }

Object mapping

CompanyPersonDealOneflow documentOneflow document participant
Company nameFirst nameDeal nameOneflow document nameParticipant name
Buying statusLast nameCompanyCreatedRole in document
ResponsibleDirect phoneResponsible at customerUpdatedSign status
Postal addressMobile phoneResponsible salespersonStatusViews
Visiting addressEmailStatusDealOneflow document
Postal zip codePositionValueOpen in OneflowCompany/Individual
Postal cityInactiveProbabilityKey eventEmail
Visiting zip codeCompanyWeighted valueLatest activity
Visiting cityLast date for anonymizationCurrencyOneflow document ID
CountryAnonymize dateSubtotalOneflow document link
TelephoneDiscount (amount)
HomepageVAT
Registration numberWon/Lost reason
Quote sent
Expected order
Order/Lost date

2.2 Oneflow document

Switch to code view, copy and paste the following JSON code.

Oneflow document JSON
{
    "general": {
        "primaryTitle": [
            {
                "property": "name"
            },
            {
                "property": "oneflowstatus"
            },
            {
                "property": "deal"
            }
        ],
        "icon": "check-document",
        "color": "#013a4c",
        "create": false,
        "enableGlobalSearch": false,
        "inlineCreate": false,
        "bulkDeleteObjects": false,
        "views": [
            {
                "title": "webclient.limeobject.table-view",
                "icon": "insert_table",
                "view": {
                    "name": "limec-table-view"
                }
            },
            {
                "title": "webclient.limeobject.list-view",
                "icon": "activity_feed_2",
                "view": {
                    "name": "limec-list-view"
                }
            }
        ],
        "promotedActions": [
            {
                "id": "limepkg_standard_actions.open-link",
                "label": "Open in Oneflow",
                "icon": "external_link",
                "color": "rgb(var(--color-brown-darker))",
                "params": {
                    "nextCommand": {
                        "params": {}
                    },
                    "link": {
                        "expectedOutputType": "auto",
                        "formula": "{{oneflow_document_link}}"
                    },
                    "openInNewTab": true,
                    "type": "url",
                    "confirm": {
                        "options": {}
                    }
                },
                "visibility": {}
            }
        ]
    },
    "card": {
        "sections": [
            {
                "title": "untitled",
                "collapsed": false,
                "visible": true,
                "visibleOnCreate": true,
                "layout": {
                    "columns": 5,
                    "dense": false
                },
                "controls": [
                    {
                        "property": "name",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {
                            "colSpan": 2
                        },
                        "component": {
                            "props": {}
                        }
                    },
                    {
                        "property": "oneflowstatus",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {
                            "colSpan": 2
                        },
                        "component": {
                            "props": {}
                        }
                    },
                    {
                        "property": "updatedinoneflow",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {},
                        "component": {
                            "props": {}
                        }
                    },
                    {
                        "property": "createdinoneflow",
                        "format": "datetime",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {},
                        "component": {
                            "props": {}
                        }
                    }
                ]
            }
        ],
        "components": [
            {
                "name": "lwc-status-flow-limeobject-header",
                "props": {
                    "optionPropName": "oneflowstatus"
                }
            }
        ],
        "tabs": [
            {
                "title": "webclient.limeobject.tabs.overview.title",
                "icon": "",
                "color": "",
                "id": "_overview",
                "component": {
                    "name": "limec-object-overview",
                    "props": {}
                }
            },
            {
                "title": "",
                "icon": "",
                "color": "",
                "id": "oneflowdocumentparticipant",
                "component": {
                    "name": "limec-object-relations",
                    "props": {
                        "relation": "oneflowdocumentparticipant"
                    }
                }
            }
        ],
        "splitView": null
    },
    "activities": {
        "isDefault": false,
        "relations": []
    },
    "feed": {
        "isDefault": false,
        "basics": {
            "sortProperty": "createdinoneflow",
            "ui": "minimal"
        },
        "header": {
            "author": "createduser",
            "heading": "created a new contract in Oneflow"
        },
        "content": {
            "body": "name"
        },
        "relations": {
            "relatedObjects": []
        }
    },
    "list": {
        "header": [
            {
                "property": "name"
            },
            {
                "property": "oneflowstatus"
            }
        ],
        "subheader": []
    },
    "search": {
        "header": [
            {
                "property": "name"
            },
            {
                "property": "oneflowstatus"
            }
        ],
        "subheader": []
    },
    "table": {
        "columns": [
            {
                "property": "name",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "oneflowstatus",
                "title": "Status",
                "isDefault": true,
                "component": {
                    "name": "lwc-limepkg-option-visualizer-table",
                    "props": {}
                }
            },
            {
                "property": "key_event",
                "title": "Key events",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "oneflowdocumentparticipant",
                "title": "# Participants",
                "isDefault": true,
                "aggregated": true,
                "aggregate": {
                    "operator": "COUNT",
                    "key": "count__0"
                },
                "component": {
                    "props": {}
                }
            },
            {
                "property": "latest_activity",
                "title": "Latest activity",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            }
        ],
        "actions": [
            {
                "id": "limepkg_bulk_export.export-data",
                "label": "limepkg_bulk_export.export-data-xlsx",
                "params": {},
                "visibility": {}
            },
            {
                "id": "limepkg_bulk_export.export-data",
                "label": "limepkg_bulk_export.export-data-csv",
                "params": {
                    "exportFormat": "csv"
                },
                "visibility": {}
            },
            {
                "id": "limepkg_bulk_update.bulk-update",
                "params": {
                    "exclude": []
                },
                "visibility": {}
            }
        ]
    }
}

2.3. Oneflow document participant

Switch to code view, copy and paste the following code.

Oneflow document participant JSON
{
    "general": {
        "primaryTitle": [
            {
                "property": "name"
            },
            {
                "property": "role"
            },
            {
                "property": "signstatus"
            }
        ],
        "icon": "contract_job",
        "color": "rgb(var(--color-gray-default))",
        "create": false,
        "enableGlobalSearch": false,
        "inlineCreate": false,
        "bulkDeleteObjects": false,
        "views": [
            {
                "title": "webclient.limeobject.table-view",
                "icon": "insert_table",
                "view": {
                    "name": "limec-table-view"
                }
            },
            {
                "title": "webclient.limeobject.list-view",
                "icon": "activity_feed_2",
                "view": {
                    "name": "limec-list-view"
                }
            }
        ]
    },
    "card": {
        "sections": [
            {
                "title": "untitled",
                "collapsed": false,
                "visible": true,
                "visibleOnCreate": true,
                "layout": {
                    "columns": 5,
                    "dense": false
                },
                "controls": [
                    {
                        "property": "name",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {},
                        "component": {
                            "props": {}
                        }
                    },
                    {
                        "property": "signstatus",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {},
                        "component": {
                            "name": "lwc-limepkg-option-visualizer-card",
                            "props": {}
                        }
                    },
                    {
                        "property": "company_individual",
                        "readonly": true,
                        "required": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {
                            "colSpan": 2
                        },
                        "component": {
                            "props": {}
                        }
                    },
                    {
                        "property": "role",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {},
                        "component": {
                            "name": "lwc-limepkg-option-visualizer-card",
                            "props": {}
                        }
                    },
                    {
                        "property": "views",
                        "readonly": true,
                        "visible": true,
                        "visibleOnCreate": true,
                        "notifyCoworker": true,
                        "help": {
                            "readMoreLink": {
                                "target": "_blank"
                            }
                        },
                        "layout": {},
                        "component": {
                            "props": {}
                        }
                    }
                ]
            }
        ],
        "tabs": [
            {
                "title": "Overview",
                "icon": "decision",
                "color": "rgb(var(--color-gray-default))",
                "id": "_overview",
                "component": {
                    "name": "limec-object-overview",
                    "props": {}
                }
            }
        ],
        "splitView": null
    },
    "activities": {
        "isDefault": false,
        "relations": [],
        "composer": {
            "component": {
                "props": {}
            }
        }
    },
    "feed": {
        "isDefault": false,
        "basics": {
            "sortProperty": "createdtime",
            "ui": "standard"
        },
        "header": {
            "author": "createduser",
            "heading": "name"
        },
        "content": {
            "body": null
        },
        "relations": {
            "relatedObjects": []
        }
    },
    "list": {
        "header": [
            {
                "property": "name"
            },
            {
                "property": "role"
            },
            {
                "property": "signstatus"
            }
        ],
        "subheader": [
            {
                "property": "oneflowdocument"
            }
        ]
    },
    "search": {
        "header": [
            {
                "property": "name"
            },
            {
                "property": "role"
            },
            {
                "property": "signstatus"
            }
        ],
        "subheader": [
            {
                "property": "oneflowdocument"
            }
        ]
    },
    "table": {
        "columns": [
            {
                "property": "name",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "role",
                "isDefault": true,
                "component": {
                    "name": "lwc-limepkg-option-visualizer-table",
                    "props": {}
                }
            },
            {
                "property": "signingorder",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "views",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "signstatus",
                "title": "Status",
                "isDefault": true,
                "component": {
                    "name": "lwc-limepkg-option-visualizer-table",
                    "props": {}
                }
            },
            {
                "property": "company_individual",
                "title": "Company/Individual",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "oneflowdocument",
                "isDefault": true,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "createdtime",
                "isDefault": false,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "timestamp",
                "isDefault": false,
                "component": {
                    "props": {}
                }
            },
            {
                "property": "id",
                "isDefault": false,
                "component": {
                    "props": {}
                }
            }
        ],
        "actions": []
    }
}

2.4 Browse Menu

  1. Login to Lime CRM as an admin and click Account and select the Administrators page.
  2. Navigate System > Browser Menu
  3. Click + Sections to add a new section.
  4. Click + Items.
  5. Set the title to “Oneflow documents” and select Oneflow documents as the Limetype.
  6. Click + Items again.
  7. Set the title to “Oneflow document participants” and select Oneflow document participants as the Limetype.
  8. Click Save.

3. Lime Administrators Page: Settings configuration

3.1 Option Visualizer

Oneflow document participant → Sign status

  • Limetype : Oneflow document participant
  • Property : Sign status
  • Prefix : Icon
  • Value : ✅
  • Visualizer configurations
    • Signed
      • Option : Signed
      • Icon : checkmark
      • Color : rgb(var(–color-green-default))
    • Pending
      • Option : Pending
      • Icon : hourglass
      • Color : rgb(var(–color-gray-default))
    • Approved
      • Option : Approved
      • Icon : checkmark
      • Color : rgb(var(–color-purple-light))
    • Declined
      • Option : Declined
      • Icon : multiply
      • Color : #D13D47
    • Delivery failed
      • Option: Delivery failed
      • Icon: high_priority
      • Color: #D13D47


Oneflow document → Status

  • Lime type : Oneflow document
  • Property : Status
  • Prefix : Colored dot
  • Value : ✅
  • Visualizer configurations
    • Draft
      • Option : Draft
      • Icon :
      • Color : rgb(var(–color-gray-default))
    • Pending
      • Option : Pending
      • Icon :
      • Color : rgb(var(–color-sky-light))
    • Overdue
      • Option : Overdue
      • Icon :
      • Color : rgb(var(–color-orange-dark))
    • Signed
      • Option : Signed
      • Icon :
      • Color : rgb(var(–color-green-dark))
    • Declined
      • Option : Declined
      • Icon :
      • Color : rgb(var(–color-red-dark))

Oneflow document participant → Role in document

  • Lime type : Document participant
  • Property : Role in document
  • Prefix : Icon
  • Value : ✅
  • Visualizer Configurations
    • Signatory
      • Option : Signatory
      • Icon : signature
      • Color :
    • Internal approver
      • Option : Internal approver
      • Icon : checked_user_male
      • Color :
    • Influencer
      • Option : Influencer
      • Icon : call_male_92444
      • Color :
    • Viewer
      • Option : Viewer
      • Icon : eye_previews
      • Color :

3.2 Status Flow

  • Limetype config
  • Oneflow document → Status
  • Visualize - Status
    • Draft
      • Option : Draft
      • Color : #A2B5BD
      • Advanced
        • Detail property
        • Property
        • Flow Item Attributes:
{
    "disabled": true
}
  • Pending

  • Option : Pending

    • Color : #509dd1

    • Advanced

      • Detail property

      • Property

      • Flow Item Attributes

{
    "disabled": true
}
  • Overdue

    • Option : Overdue

    • Color : #ef9b4e

  • Advanced

    • Detail property

    • Property

    • Flow Item Attributes

{
    "disabled": true
}
  • Signed

    • Option : Signed

    • Color : #3cc885

    • Advanced

      • Detail property

      • Property

      • Flow Item Attributes

{
    "disabled": true
}
  • Declined

    • Option : Declined

    • Color : #d13d47

    • is Off Progress : ✅

    • Advanced

      • Detail property

      • Property

      • Flow Item Attributes

{
    "disabled": true
}

Publish

Use Read the Docs to publish updates and host documentation publicly.

Troubleshooting Guide

During setup

Permission Denied for Lime Object

Solution:

  • Verify your user permissions in Lime CRM by referring to the Installation page. Contact your Lime CRM administrator to grant the necessary access rights to the specific object type.

Invalid Authentication Details

Solution:

  • Try setting up the Lime CRM integration again by re-authorizing your Lime CRM API key and try connecting again.
  • Ensure that the API key is correctly configured and has not expired.
  • Ensure that no other admin is simultaneously configuring the extension.

Incorrect Host URL

Solution:

  • Double-check the Lime CRM domain URL provided.
  • Ensure there are no typos or missing parts in the URL.

After setup

Oneflow Document Creation Fails After Setup

Description: Oneflow Document creation doesn’t launch or results in a blank page.

Solution: Ensure the Lime API key and host URL are correct. Verify the workspace and template in Oneflow exist and are accessible.

Invalid Oneflow API Token

Description: Displayed when the middleware token is invalid or not linked to a Oneflow account.

Solution: Retry setup from the Setup button in the Oneflow marketplace. Ensure authentication completes successfully and tokens are stored.

Missing Participants in Oneflow Document

Description: Expected contacts from the deal do not appear in the participant list.

Solution: Check contact linkage in Lime CRM. Ensure contacts are marked as part of the deal object and have valid email addresses.

Missing Create Oneflow document button

Solution: Ensure that you have added the promoted action button as specified in Configuration.

GDPR

What Is Done with Personal Data

Personal data is transferred from Lime CRM to Oneflow to populate contract documents and manage participants.

Explore Oneflow’s approach to data protection and compliance on the GDPR policy page.

Why Is Personal Data Needed?

To create contracts, participant details such as names, emails, and company info must be shared from the Lime CRM Object (i.e. Deals).

What Personal Data is used?

  • Contacts associated with a deal
    • Full name
    • Email address (linked with Lime CRM)
  • Companies associated with a deal
    • Company Name
    • Address
    • Email address

Transfer of Personal Data

  • Transferred securely over an HTTPS and encryption-enabled API between Lime CRM and Oneflow.

Logging of Personal Data

  • Some data is captured during token and API key validation. Data is retained as per Oneflow and Lime CRM policy.

Possible Avoidance of Using Personal Data

  • Not possible, as contracts require personal details for signatory identification.

Upgrading Guide

Oneflow app upgrades are automatically pushed to the URL where the app is published.

So far, there have been no breaking changes in the integration that would require manual installation or configuration work inside Lime CRM

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.