Getting Started

The Manage Lapps UI

The Manage Lapps UI is available under the Apps section of the main navigation panel –

managing lapps

You can create new Lapps here and view and edit previously created Lapps. The grid shows you the following information for each Lapp –

Column Name Description
Name The name of the Lapp.
Status The status (Draft, Published, Unpublished) of the Lapp in the test and live environments.
Last Published On The date the Lapp was last published in the test and live environments.
API Call Statistics* The number of successful or failed API calls for the test and live environments. Hover the mouse over the success or failure statistics to see a breakdown of the number of successful and failed calls by environment.
Modified On The last modified date of the Lapp.
Modified By The user who last modified the Lapp.
Actions
  • Edit a Lapp.
  • Unpublish a Lapp from the test environment.
  • Unpublish a live Lapp.
  • View the Lapp API URL.
  • Delete a Lapp.
  • View logs.

You can also sort the grid to show Lapps by status, modified by and modified on filters.

*API call statistics are shown for last 30 days by default and cached every 12 hours. It does not change with the grid’s filter. You can view the latest values using the refresh button provided alongside.

 

Create a Lapp Using the Editor

To create a Lapp –

  1. On the Manage Lapps page, click the Add Lapp button.
  2. Enter a name and description for the Lapp.
  3. Select the Coding Mode as Editor (write your code directly in the Lapps code editor).
  4. Next, click the Notification  icon for a quick introduction to the Lapp features.

Here the coding mode was selected as Editor

Lapp Editor

 

Create a Lapp Using a Zip File 

  1. On the Manage Lapps page, click the Add Lapp button.
  2. Enter a name and description for the Lapp.
  3. Select the Coding Mode as Zip (use your own code files packaged in zip format).
  4. Next, click the Notification  icon for a quick introduction to the Lapp features.

zip upload

 

Lapps Marketplace

If you don’t want to create a new Lapp from scratch, you can try some of our ready to use Lapps. The code for these Lapps is production ready so you can either edit it to suit your needs or start using it right away.

lapp marketplace

You can search or navigate through the categories on the left pane to find Lapps specific to your industry. Click on a Lapp to select it, then click Import.

import selected lapp

You can download and edit the Lapp by clicking the icon highlighted below or publish the Lapp immediately.

downloading zip

For Lapp templates that contain multiple files (shown above), zip upload/download mode will automatically open. For Lapps templates that contain a single file (main.js), the Lapp editor will open (shown below) –

lapp editor

Note:

  • For templates that open in the Lapp editor, be sure to read all the instructions written before the start of the code in ‘main.js’ file.
  • For zip style templates, read the instructions carefully. You may need to set additional settings to make the Lapp work, for example, some templates contain an ‘additional-settings.json’ file. In this case you’ll need to download the zip code and edit the required additional settings.

 

Example – Push Lead to a LeadSquared Account

This Lapp pushes a lead from one LeadSquared account to another LeadSquared account. You can simply edit this Lapp to push leads from an external system to your LeadSquared account.

The Lapp presupposes the following assumptions –

  • This Lapp is being called on the lead create event (either through Webhooks or through Rules if you want to add filters).
  • You have access to the target LeadSquared account and its API access and secret keys.
  • You will add all the lead fields in the ‘main’ function that are required to be passed on.
  • Once you publish this Lapp, it will be available in the list of available Lapps in Webhooks, Rules or Automation actions.
  • The Lapp code will change slightly if you intend to use it on say, “Lead Stage Change” event.

The Lapp requires you to create the following settings –

LS_API_BASE_URL The base API URL for the target LeadSquared account
LS_ACCESS_KEY LeadSquared API Access key
LS_SECRET_KEY LeadSquared API Secret key

 

Next Steps

Here’s everything you need to know about Writing Code in Lapps.