Getting started with Oneflow x Lime CRM

Angelica Angelis
Angelica Angelis
  • Updated

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.

INFORMATION

Prerequisites:

  • Contact Lime CRM’s support team to activate and configure the Oneflow integration for Lime CRM (See Phase 1 for details).
  • Ensure the Lime CRM user belongs to the “Webhook users” and “(System) Oneflow Integration” groups with the type set to “API” (See Phase 2 for details).
  • If Lime CRM is hosted on-premise, ensure the Lime CRM REST API is reachable over the internet for Oneflow to connect.

Phase 1: Contact Lime CRM to activate the integration

  1. Ask your Lime CRM system administrator to contact Lime Technologies and request the installation of the Oneflow integration. You can contact Lime via the Contact sales page. This will send a request to add the Oneflow integration to your Lime CRM account.
  2. Your Lime CRM system administrator will need to perform a series of configurations in your organization’s Lime CRM account. See Lime CRM Configuration for the detailed steps.

Phase 2: Configure 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. Log in to Lime CRM as an admin and click on Account and select the Administrators page.
Lime CRM Administrators page
  1. Navigate to Administrators page > System > Security > Users.
Users section in Lime CRM admin
  1. Create a new user (or update an existing one) with the following properties. Configure these for each user who needs to use the Oneflow integration.

    Configuring user properties
    • Username: Enter the email of the user (e.g. janedoe@gmail.com).
    • Display name: Enter a preferred display name (e.g. Jane Doe).
    • User type: Select “API”.
    • Groups: Select “Webhook Users” and “(System) Oneflow Integration”.

IMPORTANT

If you do not see a group called “Webhook Users”, create a new group with the exact same name.

  1. Click Save.

  2. Select the user using the checkbox, then click Create API key and click Generate. Click Copy to clipboard and save this API key securely as you will need it to connect Oneflow to Lime CRM.

Creating API key
Copying generated API key

Add the “Oneflow document” button to the deal

  1. Navigate to Administrators page > Views > Deal.
Deal view settings
Deal view editor
  1. Under Promoted actions, click on the + Promoted actions button to add a new one.
Adding a promoted action
  1. Complete the form with the following field values.
Promoted action configuration
  • Command id: Open link (Standard actions)
  • Action label: Oneflow document
  • Icon: add_file
  • Color: #013A4C
  • Parameters: Switch to “Code” mode, and enter the following code in the text field.

    {
      "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": {}
      }
    }
    

    If you’re in “Config” mode, complete the following fields with these values:

    • Value type: Formula
    • Expected output type: Auto
    • Formula

      https://integrations.oneflow.com/api/lime_crm/generate_token?object_type=deal&object_id={{id}}&user_email={{context.active_user.email%20|%20urlencode}}&user_id={{context.active_user.id}}
  1. Save the promoted action button. A “Oneflow document” button will be added to your Deal view in Lime CRM.
Promoted action saved
  1. A button called “Oneflow document” will appear on any open deal view.
Oneflow document button in Deal view

Phase 3: Connect Lime CRM to Oneflow

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

Lime CRM in Oneflow Marketplace
  1. Enable the extension and click on the Setup button. This will launch the Oneflow Lime integration setup.

  2. Enter your Lime host URL and Lime API key and click Connect.
Lime CRM connection setup
  1. Lime CRM URL: Enter the main URL that you use to log in to Lime CRM containing your organization’s name. Example: https://your-company-name.limecrm.com/name/

    To know your Lime CRM URL, log in to Lime CRM and go to Account > Administrators page and copy the URL section along with the client name (highlighted in the image).

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

  2. Lime API key: Enter the API key you generated for your Lime CRM user from the admin panel (in Step 4 of Phase 2).

    Finding Lime CRM URL

Create a Oneflow template for Lime CRM

  1. Log in to Oneflow and ensure you have at least one active workspace. Navigate to the Templates page and create a new template from the template library or start from scratch.
  2. Click on the Data fields icon in the side panel. From the Select playbook dropdown, select Lime CRM Template.

  3. Click on the current template name and enter a new name for your template (e.g., “Lime CRM Template”).
  4. Customize the template to match your preferences by adding sections to it and click Publish.

Publishing a Lime CRM template
  1. You can now start creating Oneflow documents by opening a deal in Lime CRM and clicking the promoted action button used to create a Oneflow document.

Create a Oneflow document

  1. Open a deal in Lime CRM.
  2. Click on the Oneflow document promoted action button that you created (in Phase 2) to initiate the process. The create document page will open in a new tab.
Oneflow document button on Deal page
  1. Select a Oneflow workspace and template, then edit the name of the document (the Oneflow document name is populated by default).
Create document page
  1. Select participants to add to the Oneflow document (optional). The contacts in your deal appear in the participants section. Ensure the contacts have email addresses or phone numbers.
    Role: Select the role for the participant in the contract (Signatory, Influencer, Viewer).

    Participant type: Select a participant type from the dropdown, e.g., whether to add the contact as an Individual or as part of a company.
Adding participants to the document
  1. Click on the Create document button. You will be redirected to Oneflow.

Oneflow Document Status Sync

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

    Oneflow documents tab in Lime CRM
    • Draft, Pending, Overdue, Signed, and Declined Oneflow documents are listed.
    • Clicking on a Oneflow document name reveals its status, created/updated dates, and participant details (such as name, type, status, and role).
Document details card
  • Once the Oneflow document is sent to participants, the status is updated inside the card on the Lime CRM deal, allowing for at-a-glance visibility of contract progress.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request