[dynamic_help_sidebar root="leads"]

How to Migrate to the Zoom OAuth App

Important:

  • This article covers steps to migrate from Zoom’s JWT app to Zoom’s OAuth app. Only the Zoom authentication method has changed in the LeadSquared Zoom connector, while everything else remains the same.
  • If your LeadSquared account has any custom logic implemented for Zoom Meetings or Zoom Webinars, do not migrate before reaching out to your account manager. They’ll review your connector, and make necessary changes for you to migrate to the new app.
  • Zoom plans to deprecate the JWT App feature on 1st September, 2023. Post that, the JWT App you used to integrate with the LeadSquared Zoom Meeting Connector will not function, and your Zoom meeting and webinars will not get synced with LeadSquared.

Zoom LeadSquared Integration

1. Feature Overview

This article lists down steps to help you migrate from the Zoom JWT App to the Zoom OAuth App. This is mandated by Zoom. We recommend you migrate to the Zoom OAuth app because of the following reasons –

  • Security Enhancement – The new OAuth app is built using OAuth to authorize user credentials.
  • Deprecation of the JWT method – Zoom is deprecating the JWT method. To know more, refer to JWT App Type Deprecation FAQs.
Note: This article is applicable only to accounts where the LeadSquared Zoom Meeting Connector was installed and configured before 1st June, 2023.

What happens if the JWT app stops working and you haven’t migrated to the new OAuth connector?

  • LeadSquared won’t receive updates from Zoom for any future dated meeting created from LeadSquared. The meeting start and end activities won’tt be posted once the JWT app is deprecated.
  • You won’t be able to schedule new Zoom meetings from LeadSquared.
  • In case of webinars, lead registrations won’t be captured in LeadSquared.
  • Sales Users won’t be able to add leads to Webinars.
  • Webinar participants joined/left activities won’t be posted in LeadSquared. Task creation won’t work.
  • Also, any custom implementation setup on top of Zoom Meetings/Webinars might get affected.

 

2. Migration Steps in LeadSquared

  1. On your LeadSquared account, navigate to Apps>Apps Marketplace, and search for the Zoom Meeting Connector.
  2. Hover your cursor over the settings icon, and click Configure.
  3. On the Configure Zoom Meeting Connector pop-up, click the Sign in with Zoom button, and use your Zoom account credentials to sign in to the connector.
  4. Once you successfully sign in, your Zoom account will get connected to the Leadsquared Zoom Meeting Connector.
    1. If you’re using the Zoom Webinar feature, then navigate to the Webinar Settings tab, and repeat the steps listed above in this section.

Note:

  • Signing in through the Authentication tab will only capture your Zoom Meeting details, and this WILL NOT automatically capture Zoom Webinar details. If you want to capture Webinar details, it is mandatory to navigate to the Webinar Settings tab and sign in using your Zoom credentials.
  • If you use two different Zoom accounts for Meetings and Webinars, you can sync both these accounts with the Zoom Meeting Connector, by signing in with the relevant Zoom credentials on the Authentication and Webinar Settings tabs.
  • You can use the same Zoom account credentials to sign in on the Authentication tab and the Webinar Settings tab.
  • If you’re the owner of multiple LeadSquared accounts, and if the Zoom Meeting Connector is installed in more than one account, ensure you authenticate each Zoom Meeting Connector using different Zoom account credentials.
    • If you use the same Zoom account credentials to authenticate all the connectors, then you’ll automatically be logged out of all the connectors, except for the last connector you authenticated with your Zoom account details.

LeadSquared Zoom Connector

 

3. Migration Steps in Zoom

Once you’ve signed in to the LeadSquared Zoom Meeting Connector using your Zoom account credentials, navigate to the Zoom Marketplace.

3.1 View the LeadSquared Apps

On the Zoom Marketplace, search and view the LeadSquared Apps –

  • LeadSquared –  This app is to manage your Zoom Meetings in LeadSquared. Once you sign in to Zoom from the LeadSquared Zoom Meeting Connector, this app will automatically get connected to your Zoom account.  You can read more about this in the Zoom marketplace.
  • Webinar for LeadSquared – This app is to manage your Zoom Webinars in LeadSquared. Once you sign in to Zoom from the Zoom Webinars tab on the Zoom Meeting Connector, this app will automatically get connected to your Zoom account.

LeadSquared Zoom Connector

 

3.2 Action required in Zoom Marketplace

  • With the introduction of the OAuth app, you don’t need to manually add event triggers and webhooks for Meetings/Webinars (like it was previously required in the Zoom JWT app). Now, the meeting/webinar app automatically gets installed in your Zoom account, as soon as you sign in to the LeadSquared Zoom Meeting Connector.
  • Event notification triggers are pre-subscribed, and no action is required from your end for either of the apps (LeadSquared and Webinar for LeadSquared).

 

3.3 Deactivating the JWT app from Zoom’s Marketplace

  1. After you’ve successfully connected your Zoom account with the LeadSquared Zoom Meeting connector, test the integration by creating a test meeting/webinar from your Zoom account. This is to ensure the connection is stable and working as expected
  2. Once you’re satisfied with the test results, navigate to the Zoom Marketplace.
  3. Under the Manage section, alongside the Zoom LeadSquared JWT app you’d previously created, click remove.
    • To identify the JWT app, on the Created Apps section, under the Type column, search for JWT.
  4. Then, navigate to the Activation tab, and alongside the JWT app, click Deactivate Your App.
Note: If you don’t deactivate the JWT app, duplicate leads will be captured in your LeadSquared account, and duplicate Zoom meeting and webinar activities will be posted.

LeadSquared Zoom Connector

 

4. FAQs

  • In your Zoom connector, who can sign in to integrate the LeadSquared connector with your Zoom account?
    Only a Zoom Admin user, with all required permissions, can sign in to the Zoom Meeting connector. If you face any issues (such as the one listed in the below image), please contact your Zoom account manager, and they’ll help you out.

Zoom LeadSquared Integration

 

  • How much time will it take to migrate to the upgraded OAuth app?
    It should only take a few minutes to migrate, since the only action required from your end is to Sign in to the LeadSquared app using your Zoom credentials.

 

  • Is it mandatory to deactivate the JWT app that you had previously created in Zoom?
    Yes, Zoom have announced that they’ll deprecate the JWT app on 30th May, 2023. If the JWT app is not deactivated, it may cause issues with your integration. Using both integrations in parallel will result in duplicate leads and activities getting created.

 

  • What are the names of the new Zoom OAuth apps created by LeadSquared?
    There are two new apps created by LeadSquared are –

    • LeadSquared – This is to integrate Zoom Meetings with LeadSquared.
    • Webinar for LeadSquared – This is to integrate Zoom Webinars with Webinars.

 

  • Do you have to install the new LeadSquared apps on my Zoom Developer account?
    No, these apps are automatically installed when you sign in to the Zoom Meeting Connector (in your LeadSquared account) using your Zoom account credentials.

 

  • Are any actions required from your end once the LeadSquared apps are installed on your Zoom account?
    No, no further action is required from your end.

 

  • Can I sign in using two use Zoom accounts in the Zoom Meeting Connector?
    It is mandatory to sign in using at least one Zoom account with LeadSquared. But you can use two different accounts to sign in on the Authentication tab and Webinar Settings tab. Please ensure the user licenses are available and valid for each account.

 

  • Your organization has multiple LeadSquared accounts (tenants), and you use Zoom in more than one account. What should you do?
    • You can install the Zoom Meeting Connector on all your LeadSquared accounts. But you need to ensure you sign in on the Webinar Settings tab for each connector using different Zoom user accounts. For e.g., if you’ve signed in to the Webinar Settings tab in your LeadSquared account 1 using the Zoom credentials for john@example.com, then you cannot use the same account when signing in on the Webinar Settings tab in your LeadSquared account 2. You’ll have to use different Zoom credentials here (e.g., smith@example.com).
    • If you’ve used the same Zoom credentials (john@example.com in our example) when signing in to different LeadSquared accounts, then the last account on which you’ve signed in will remain connected (LeadSquared account 2 in our example), while the previous accounts (LeadSquared account 1 in our example) will get disconnected from Zoom Webinars.

 

Any Questions?

Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!

Integrate Bouncify with LeadSquared

1. Feature Overview

This connector sends leads from your LeadSquared account to your Bouncify account. The connector will verify a lead’s email address and then from the response, LeadSquared will post an activity against the lead. 

 

2. Prerequisites

  • You must be the Administrator of your LeadSquared account.
  • You must have an active Bouncify account.
  • This is a paid feature. To enable it, reach out to your account manager, or write to support@leadsquared.com.

 

3. How it Works

To push leads from LeadSquared to your Bouncify account, configure the Bouncify connector. Once configured, enable the connector sync.

During configuration, a webhook URL is generated in LeadSquared. Copy this URL and configure it in your Bouncify account.

 

4. Installation

You must first install and configure the Bouncify connector.

  1. Navigate to Apps>Apps Marketplace.
  2. Search for Bouncify, and click Install.
    • Alternatively, you can find the connector on the left panel, under Verifications.
  3. Once installed, hover your cursor over , and click Configure.

bouncify install

4.1 Configure the connector

Once you’ve installed the connector, on the Configure Bouncify pop-up, configure the connector access for the non-Admin users in your account. Only those users for whom access is granted can view and access the connector (under the Apps main menu).

  1. Select if you want to grant Connector Access that’s Based on Role or Advanced (User Level).
    • Based on Role – From the Specify Roles dropdown, select the LeadSquared user roles that can use the connector.
    • Advanced (User Level) – From the Advanced (User Level) dropdown, select a user boolean field. Based on the value entered in the selected boolean field, the user can access the connector (e.g., for the user Sam, if the “Is Employee” boolean user field contains the value “Yes”, then this user can access the connector).
  2. Once you’re done, click Save Details. To continue the configuration, refer to the below sections.
Note: By default, all Admin users will have access to the connector.
bouncify config

 

5. Admin Configuration

To continue the connector configuration, navigate to Apps>Bouncify.

bouncify admin config

5.1 Basic Settings

Enter the following details –

Property Description
API Key Pass your Bouncify account’s API Key here.
Lead Source Enter the lead source through which the leads were captured (e.g., Bouncify, email campaign, etc.). This detail will be displayed on the Lead Details page, under Lead Source.
Default Country Code If the lead’s mobile number is captured without a country code, the default country code that’s selected from the dropdown will be added to the lead’s mobile number.
Select Time Zone The time zone followed in your Bouncify account.
Lead Capture Search By Criteria To avoid duplicate leads, you must select one unique lead field (e.g., email Id, mobile number, PAN number, etc.) as the search key. This is used to identify the leads pushed from Bouncify.

To know how to mark a LeadSquared lead field as unique, please refer to How to Make a Custom Field Unique.

Lead Capture Secondary Search By Criteria If lead identification and capture through the primary Search By criteria fails, it will be re-attempted using the secondary Search By criteria.
Select User to Notify on Failure If there is an error in fetching leads, the selected user will receive a failure message via email. You can select a user from the list of all the users available in your LeadSquared account.

To know more about the type of errors, please refer to Error Notifications.

Enable Notification To ensure notification emails are sent to the selected user when there’s a failed query, enable the Checkbox checkbox.

Once you’ve entered all the details, click Save & Next.

bouncify basic settings save

 

5.2 Entity Options

Define the sync behavior of the connector when leads are captured.

5.2.1 Lead/Contact Entity

Based on the Lead Capture Search By criteria (email Id, phone number, etc.), LeadSquared identifies and captures leads from your Bouncify account. Lead capture is enabled by default, and it cannot be disabled. The following options are available to configure the connector’s Sync Behaviour –

  • Capture (Create and Update existing) Record – Leads that only exist in your Bouncify account (but not in your LeadSquared account) will get created in LeadSquared. Leads that exist in both your data provider and LeadSquared accounts will get updated.
  • Create only new record – Leads that only exist in your Bouncify account (but not in your LeadSquared account) will get created in LeadSquared.
  • Update only existing record – Leads that exist in both your Bouncify account and LeadSquared accounts will get updated in LeadSquared.
  • Do nothing – Leads do not get created or updated by syncing.
Note: This connector takes your lead details and verifies them. After which, LeadSquared will use that data to post an Activity against the lead. So, the Sync Behaviour is by default set to Do Nothing. It is recommended you don’t change this to any other setting.

bouncify lead sync

5.2.2 Mapping

On the Mapping screen, the Bouncify system fields mapped to the corresponding LeadSquared lead fields are visible. This mapping is carried out by default. If required, you can change or update the default field mapping.

  • To provide a default value for any field, click  , enter the value under Default Value, and click Google.
    • If the data provider doesn’t send data for any lead field, then the default value will get assigned to that specific field. But if the field already has an existing value, then the default value will be ignored.
  • To disable lead data capture for any field, disable the Zoom slider.
  • You can also mark and update a unique lead field as the search key from this screen, by clicking unique icon.
  • To create a custom Bouncify field, click the Add Custom button.
    1. Once this field is created, you must map it to the relevant LeadSquared lead field.
    2. After the field is mapped, to save the custom field, click Google.
    3. To delete a custom field, click .

Once you’re done, click Save & Next.

Note: Based on the lead fields configured in your Bouncify account, add or update the lead fields in LeadSquared.

bouncify lead mapping

 

5.2.3 Send Lead e-Mail for verification

You can use this action to send the lead’s email address for verification.

  1. On the Mapping screen, click    if you need to edit the API Params, Default Mapping Key, and Description.
  2. click Save & Close.

bouncify send email mapping

 

5.2.4 Activity Entity

Once leads are captured to LeadSquared, you can post custom activities to these leads (e.g., Ticket Creation, Chat Transcript, etc.). These activities will help users keep track of the lead’s journey to conversion.

Note: Ensure you complete the Enable Activity Creation steps first, and only then complete Edit Mapping. Alongside Lead verification activity click the Create Activity button. Ensure that in the activity entity, the activity type is Lead verification activity

To post activities to the leads captured from Bouncify, against Activity Entity, enable the Slider slider. The following options are available to configure the connector’s Sync Behaviour when activities are synced to LeadSquared –

  • Capture (Create and Update existing) Record – New activities will get posted to the lead in LeadSquared while existing activities will get updated.
  • Create only new record – Only new activities will get posted to leads in LeadSquared.
  • Update only existing record – Only existing activities on the leads captured will get updated in LeadSquared.

Once done, click Save & Next.

bouncify activity mapping

5.3 Generate Webhook URL

After you provide basic details and finish field mapping, a custom webhook URL is generated. To automate lead capture, copy this URL and configure it on your Bouncify account.

After you’ve set up the webhook, click More Actions, and enable the sync job. This ensures that through the webhook, lead data from Bouncify is pushed to LeadSquared.

Note: To view logs of all the sync jobs that have taken place, from the More Actions dropdown, click View Logs.

bouncify webhook url

 

6. Create an Automation

Use the Webhook URL to create an automation that sends a lead’s email address to Bouncify for verification.

  1. Navigate to Workflow>Automation, click Create Automation, and select the New Lead trigger.
  2. On the Automation starts when a lead is added pop-up –
    • Click +Add Conditions.
    • The Automation should run for new leads that have an email address, so, add a criteria that checks the email lead field contains data.
    • Once you’re done, click Save.
  3. Click Add Automation, and under Custom, click Webhook.
  4. On the Webhook pop-up, enter the following details –
    • Name – Enter a relevant name for the webhook. We’re calling it “Bouncify Lead verification Activity”.
    • URL – Select the method as https://, and paste the connector’s webhook URL that was generated in the previous step. Ensure you remove “https://” from the URL.
    • Content Type – Select application/json.
    • Save Response – You can select either Yes or No.
    • Custom Headers – You can skip this step.
    • Notify on Failure – Select which user you want to notify if the webhook fails.
    • Retry Count – The number of times you want to retry when the webhook fails.
  5. Once you’re done, click Save, and then click Publish.
Note: To know more about the Webhook action, refer to User Automation Actions – Webhook.

bouncify automation

 

7. View Logs

Here, you can view logs of all the sync jobs that have taken place. View New Events (New Leads), Updated Events (Updated Leads), and Errors (when capturing leads).

  1. Navigate to Apps>Bouncify.
  2. From the More Actions dropdown, click View Logs.
  3. You can filter the logs by selecting a date range (Today, Last 7 Days, This Month, and Last Month), by selecting the Job Status (“All”, “Success” and “Failure”), and by selecting the Sync Status (All, Error, and Success).
  4. You can view the sync status of the following events –
    • New Events – List of all the new leads that have been created in LeadSquared during the selected date range.
    • Updated Events – A list of all the –
      • Duplicate leads that were created with the same Search by Criteria value (e.g., with the same Email Id, Mobile Number, etc.).
      • Leads that previously contained errors, which were fixed and synced successfully.
    • Failed – The list of leads that have not been captured due to mapping errors (e.g., when a boolean field is mapped to an integer field, etc.).
  5. To view the Sync Response details, under Request ID/Sync Job ID, click the Id.
    • Under the right panel, you can view the response status, the API URL, the request, and the response.
    • The responses that are successful will contain the details of the leads that have been pushed from Bouncify.
    • To view the lead capture response under Sync API Response, Leads Updated and Errors in Leads, click Information.

Note:

  • For a response that contains an error, the reason for the error is listed in the response. Once you fix it, you can click the Retry button to perform the sync again.
  • The current Lead Sync Behaviour will reflect in the Logs screen. This will help identify the sync that’s used (Capture or Update) for the selected Request/Sync Job Id.

google forms view logs

 

8. Other Actions

You can edit or delete the Bouncify connector instance that you created. To do this –

  1. Navigate to Apps>App Marketplace.
  2. Search for Bouncify.
  3. Alongside the Bouncify connector, hover your cursor over .
  4. From the list of options, you can perform the following actions –
    • Edit Configuration
    • Disable Configuration
    • Remove Configuration

bouncify more actions

 

9. View Reports

You can view the total number of leads that have been pushed by Bouncify, by referring to the Lead Source report. To know more, please refer to How to track the source of your Leads using Lead Source Report?

Integrate LeadSquared with Google Forms

 

Any Questions?

Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!

Integrate SuperBot with LeadSquared

1. Feature Overview

This connector sends lead details like name, phone number, etc., to your SuperBot account.

 

2. Prerequisites

  • You must be the Administrator of your LeadSquared account.
  • You must have an active SuperBot account.
  • This is a paid feature. To enable it, reach out to your account manager, or write to support@leadsquared.com.

 

3. How it Works

To push leads from LeadSquared to your SuperBot account, configure the SuperBot connector. Once configured, enable the connector sync.

During the configuration, a webhook URL is generated in LeadSquared. Copy this URL and configure it in your Automation.

 

4. Installation

You must first install and configure the SuperBot connector.

  1. Navigate to Apps>Apps Marketplace.
  2. Search for SuperBot, and click Install.
    • Alternatively, you can find the connector on the left panel, under Telephony.
  3. Once installed, hover your cursor over , and click Configure.

Superbot install

4.1 Configure the connector

Once you’ve installed the connector, on the Configure SuperBot pop-up, configure the connector access for the non-Admin users in your account. Only those users for whom access is granted can view and access the connector (under the Apps main menu).

  1. Select if you want to grant Connector Access that’s Based on Role or Advanced (User Level).
    • Based on Role – From the Specify Roles dropdown, select the LeadSquared user roles that can use the connector.
    • Advanced (User Level) – From the Advanced (User Level) dropdown, select a user boolean field. Based on the value entered in the selected boolean field, the user can access the connector (e.g., for the user Sam, if the “Is Employee” boolean user field contains the value “Yes”, then this user can access the connector).
  2. Once you’re done, click Save Details. To continue the configuration, refer to the below sections.
Note: By default, all Admin users will have access to the connector.
superbot configure

 

5. Admin Configuration

To continue the connector configuration, navigate to Apps>SuperBot.

superbot admin config

5.1 Basic Settings

Enter the following details –

Property Description
Api Key Pass your SuperBot account’s API Key here.
Campaign ID Pass your SuperBot campaign ID here.
SuperBot ID Pass your SuperBot ID here.
Lead Source Enter the lead source through which the leads were captured (e.g., SuperBot, email campaign, etc.). This detail will be displayed on the Lead Details page, under Lead Source.
Default Country Code If the lead’s mobile number is captured without a country code, the default country code that’s selected from the dropdown will be added to the lead’s mobile number.
Select Time Zone The time zone followed in your SuperBot account.
Lead Capture Search By Criteria To avoid duplicate leads, you must select one unique lead field (e.g., email Id, mobile number, PAN number, etc.) as the search key. This is used to identify the leads pushed from Superbot.

To know how to mark a LeadSquared lead field as unique, please refer to How to Make a Custom Field Unique.

Lead Capture Secondary Search By Criteria If lead identification and capture through the primary Search By criteria fails, it will be re-attempted using the secondary Search By criteria.
Select User to Notify on Failure If there is an error in fetching leads, the selected user will receive a failure message via email. You can select a user from the list of all the users available in your LeadSquared account.

To know more about the type of errors, please refer to Error Notifications.

Enable Notification To ensure notification emails are sent to the selected user when there’s a failed query, enable the Checkbox checkbox.

Once you’ve entered all the details, click Save & Next.

Superbot basic settings save

 

5.2 Entity Options

Define the sync behavior of the connector when leads are captured.

5.2.1 Lead/Contact Entity

Based on the Lead Capture Search By criteria (email Id, phone number, etc.), LeadSquared identifies and captures leads from your SuperBot account. Lead capture is enabled by default, and it cannot be disabled. The following options are available to configure the connector’s Sync Behaviour –

  • Capture (Create and Update existing) Record – Leads that only exist in your SuperBot account (but not in your LeadSquared account) will get created in LeadSquared. Leads that exist in both your data provider and LeadSquared accounts will get updated.
  • Create only new record – Leads that only exist in your SuperBot account (but not in your LeadSquared account) will get created in LeadSquared.
  • Update only existing record – Leads that exist in both your SuperBot account and LeadSquared accounts will get updated in LeadSquared.
  • Do nothing – Leads do not get created or updated by syncing.
Note: This connector sends lead details like Name, Phone number, etc., to SuperBot. So, the Sync Behaviour is by default set to Do Nothing. It is recommended you don’t change this to any other setting.

superbot lead sync

5.2.2 Mapping

On the Mapping screen, the SuperBot system fields mapped to the corresponding LeadSquared lead fields are visible. This mapping is carried out by default. If required, you can change or update the default field mapping.

  • To provide a default value for any field, click  , enter the value under Default Value, and click Google.
    • If the data provider doesn’t send data for any lead field, then the default value will get assigned to that specific field. But if the field already has an existing value, then the default value will be ignored.
  • To disable lead data capture for any field, disable the Zoom slider.
  • You can also mark and update a unique lead field as the search key from this screen, by clicking unique icon.
  • To create a custom SuperBot field, click the Add Custom button.
    1. Once this field is created, you must map it to the relevant LeadSquared lead field.
    2. After the field is mapped, to save the custom field, click Google.
    3. To delete a custom field, click .

Once you’re done, click Save & Next.

superbot lead mapping

5.2.3 Send details to SuperBot API

You can use this action to send Lead details like Name, Phone Number, etc to SuperBot API using this custom action.

  1. On the Mapping screen, click    if you need to edit the API Params, Default Mapping Key, and Description.
  2. click Save & Close.
  3. Once you are done, click Save & Next.

superbot send lead details

 

5.3 Generate Webhook URL

After you provide basic details and finish field mapping, a custom webhook URL is generated. To automate lead capture, copy this URL and configure it on your SuperBot account.

After you’ve set up the webhook, click More Actions, and enable the sync job. This ensures that through the webhook, lead data from SuperBot is pushed to LeadSquared.

Note: To view logs of all the sync jobs that have taken place, from the More Actions dropdown, click View Logs.

superbot webhook url

 

6. Create an Automation

Use the Webhook URL to create an automation that sends lead details like Name, Phone number, etc., to SuperBot. 

  1. Navigate to Workflow>Automation, click Create Automation, and select an appropriate trigger. We will be selecting the New Lead trigger.
  2. Click Add Automation, and under Custom, click Webhook.
  3. On the Webhook pop-up, enter the following details –
    • Name – Enter a relevant name for the webhook. We’re calling it “Send Lead Details to SuperBot”.
    • URL – Select the method as https://, and paste the connector’s webhook URL that was generated in the previous step. Ensure you remove “https://” from the URL.
    • Content Type – Select application/json.
    • Save Response – You can select either Yes or No.
    • Custom Headers – You can skip this step.
    • Notify on Failure – Select which user you want to notify if the webhook fails.
    • Retry Count – The number of times you want to retry when the webhook fails.
  4. Once you’re done, click Save, and then click Publish.
Note: To know more about the Webhook action, refer to User Automation Actions – Webhook.

superbot automation

 

7. View Logs

Here, you can view logs of all the sync jobs that have taken place. View New Events (New Leads), Updated Events (Updated Leads), and Errors (when capturing leads).

  1. Navigate to Apps>SuperBot.
  2. From the More Actions dropdown, click View Logs.
  3. You can filter the logs by selecting a date range (Today, Last 7 Days, This Month, and Last Month), by selecting the Job Status (“All”, “Success” and “Failure”), and by selecting the Sync Status (All, Error, and Success).
  4. You can view the sync status of the following events –
    • New Events – List of all the new leads that have been created in LeadSquared during the selected date range.
    • Updated Events – A list of all the –
      • Duplicate leads that were created with the same Search by Criteria value (e.g., with the same Email Id, Mobile Number, etc.).
      • Leads that previously contained errors, which were fixed and synced successfully.
    • Failed – The list of leads that have not been captured due to mapping errors (e.g., when a boolean field is mapped to an integer field, etc.).
  5. To view the Sync Response details, under Request ID/Sync Job ID, click the Id.
    • Under the right panel, you can view the response status, the API URL, the request, and the response.
    • The responses that are successful will contain the details of the leads that have been pushed from SuperBot.
    • To view the lead capture response under Sync API Response, Leads Updated and Errors in Leads, click Information.

Note:

  • For a response that contains an error, the reason for the error is listed in the response. Once you fix it, you can click the Retry button to perform the sync again.
  • The current Lead Sync Behaviour will reflect in the Logs screen. This will help identify the sync that’s used (Capture or Update) for the selected Request/Sync Job Id.

google forms view logs

 

8. Other Actions

You can edit or delete the SuperBot connector instance that you created. To do this –

  1. Navigate to Apps>App Marketplace.
  2. Search for SuperBot.
  3. Alongside the SuperBot connector, hover your cursor over .
  4. From the list of options, you can perform the following actions –
    • Edit Configuration
    • Disable Configuration
    • Remove Configuration

superbot extra

 

Any Questions?

Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!

Document Designer

1. Feature Overview

LeadSquared’s Document Designer is a DIY feature that lets you create document templates (such as Application Forms, Fee Receipts, etc.). When a lead fills out a form on your Portal, their data is automatically populated into the document template. This template can then be previewed and downloaded by your leads from the portal.

Through this feature, you can create documents from scratch, or build documents using pre-existing templates available by default in your account. This gives you complete control over the look and feel of the documents hosted on your website, and helps streamline the entire document generation process. What’s more, you can make real-time updates and changes to live document templates on your own, without having to depend on the LeadSquared support team. This will help increase efficiency, and reduce turn-around time (TAT).

Note: This connector is currently available only for customers in India and the USA.

LeadSquared Document Designer

 

2. Prerequisites

  • This is a paid feature. To enable it, contact your account manager, or write to support@leadsquared.com.
  • You must be an Admin user to install this feature and create document templates.

 

3. How it Works

Choose to integrate either Activities, Opportunities or Leads with the Documents you generate. The fields of the selected entity type will be available for mail merging in the generated document.

Note: You can also choose to create lead-based templates. To do this, select Activities or Opportunities, and follow the steps listed below. The important thing to note here is, after you select either of the entity types available (Activities or Opportunities), DO NOT integrate any of the corresponding Activity or Opportunity fields with the template. Instead, select and integrate the relevant lead fields with the template.

If you choose to Mail Merge Activity fields –

Before you install the Document Designer app, Create a Custom Activity that’ll be posted when a lead performs an action on your website/Portal (e.g., Application Submission, etc.). To generate payment receipts, you can choose to integrate a system-generated Payment Activity.

When creating the custom activity, it’s recommended you include the below two fields in the activity. Alternatively, you can also choose to create these as lead fields in your account –

  • A String type field to store the document generation status.
  • A Custom Field Set (CFS) field with the Type set to File and the File Type set to PDF to store the URL of the generated document.

LeadSquared Document Designer

  1. Once the custom activity is created, install the connector, and select Activity as the entity type. When configuring the form design, you can choose to create a template from scratch or edit a pre-existing template.
  2. After preparing the document design, Publish it. During the publishing process, choose the CFS PDF file type custom activity field you created to store the document URL. Additionally, select the String type activity field you created to store and display the document generation status.
  3. After publishing the document, a webhook URL is generated. Use this URL to configure an Automation using the custom activity you created as the trigger. Add a webhook card to this automation, and pass the webhook URL. This ensures that whenever the custom activity is posted, the webhook is triggered, leading to the generation of the document.
  4. Add the CFS field (from the custom activity) to the portal/website (either directly to the portal code or by adding a block using the Portal Designer), where your leads can preview and download the document.

If you choose to Mail Merge Opportunity fields –

Before you install the Document Designer app, it’s recommended you have an Opportunity type that contains the following fields. Alternatively, you can also choose to create these as lead fields in your account –

  • A String type field to store the document generation status.
  • A Custom Field Set (CFS) field with the Type set to File and the File Type set to PDF to store the URL of the generated document.

LeadSquared Document Designer

  1. Once the opportunity is created/updated with the fields mentioned above, install the connector, and select Opportunity as the entity type. When configuring the form design, you can choose to create a template from scratch or edit a pre-existing template.
  2. After preparing the document design, Publish it. During the publishing process, choose the CFS PDF file type opportunity field you created to store the document URL. Additionally, select the String type opportunity field you created to store and display the document generation status.
  3. After publishing the document, a webhook URL is generated. Use this URL to configure an Automation using any trigger on the opportunity you created/updated. Add a webhook card to this automation, and pass the webhook URL. This ensures that whenever the automation is triggered, the webhook is triggered, leading to the generation of the document.
  4. Add the CFS field (from the opportunity) to the portal/website (either directly to the portal code or by adding a block using the Portal Designer), where your leads can preview and download the document.
Note: For demonstration purposes, we used the Activity entity type to set up and configure the connector and automation. The steps to configure Opportunities as the entity type remain the same, unless specified otherwise.

 

4. Install the Connector

Before you create document templates, you must install the Document Designer connector in your account –

  1. Navigate to Apps>Apps Marketplace.
  2. Search for Document Designer, and click Install.
    • Alternatively, you can find the connector on the left panel, under Generic Integration.
  3. Once installed, hover your cursor over , and click Configure. On the Configure Document Designer pop-up, click Open Document Designer.

LeadSquared Document Designer

 

5. Create Document Templates

Once the connector is installed, to design the document generation process –

  1. Navigate to Apps>Document Designer.
  2. On the Document Designer page, click the New Template button.
  3. On the Create Document Template pop-up, enter the following details –
    • Template Name – An internal display name for the template.
    • Select Entity – Select the LeadSquared entity whose fields you want to use for mail-merging with the document. You can choose between Activity and Opportunity.
      • Activity – Select the custom activity you created to store the generated document and its status.
      • Opportunity – Select the opportunity you created/updated, where you’ll store the generated document and its status.
  4. Once you’re done, click Continue.
  5. You can either choose to build a document from scratch, or you can edit and modify a pre-existing template. We’ll be editing a pre-existing template and selecting the Application Form template.
  6. Then, Select Page Size. You can choose between the A4 format or US Letter Size format.

Note:

  • If you choose to integrate leads with the template, select either Activity or Opportunity from the Select Entity dropdown. However, ensure you integrate lead fields only with the template in the subsequent steps listed below.
  • The components required to create a template from scratch are similar to the components present when editing a template. You can refer to the steps listed below if you’re looking to create a template from scratch.

LeadSquared Document Designer

 

6. Add Components

Configure the components you want to add to your document.

6.1 Header

The header is the top-bar section in the document. Edit and configure the header to reflect your organization’s details.

LeadSquared Document Designer

Header Design
From the options listed under Header Design Styles, select the background design style and the background colour of the Header. From the colour picker, select the background colour. Alternatively, you can enter the hex code of the colour of your choice.

LeadSquared Document Designer

Logo
The logo that’s displayed in the document header. To change the header logo, click LeadSquared Document Designer, and enter the Image URL of the new logo.

Note: Only URLs of images uploaded to the Images and Documents library are supported.

LeadSquared Document Designer

Header Text
Configure the Heading and Body display text present on the form header.

  • Heading Text – The header display text. Only alpha-numeric characters are supported. You can add up to 40 characters in the Header (including spaces), and 100 characters in the Body (including spaces).
  • Font Family – From the dropdown, select the header text font.
  • Font Size – Configure the header text font size.
  • Colour – From the colour picker, select the font colour. Alternatively, you can enter the hex code of the colour of your choice.
  • Style – You can also change the text style to Bold, Italics and Underline.

LeadSquared Document Designer

Add Fields
You can display data present in lead/activity fields directly on the document. For e.g., you can select the Gender lead field to dynamically display the lead’s gender. You can select custom and system lead fields, but only custom activity fields.

Note: You can also edit and update the Label Name (field name).

LeadSquared Document Designer

Special Fields

Here, you can choose to display the date on which the document was generated.

LeadSquared Document Designer

6.2 Section

A section is used to display text content, along with lead/activity field details. Each section contains a Heading and Subheading text box, and under each subheading, you can add lead/activity fields. You can add and configure multiple sections. You can also mail merge lead/activity fields to dynamically display data stored in these fields.

LeadSquared Document Designer

Section Heading
Enter and configure the header text for a section.

  • Heading Text – The header display text. Only alpha-numeric characters are supported. You can add up to 40 characters in the Header (including spaces).
  • Font Family – From the dropdown, select the header text font.
  • Font Size – Configure the header text font size.
  • Colour – From the colour picker, select the font colour. Alternatively, you can enter the hex code of the colour of your choice.

LeadSquared Document Designer

Section Subheading Text
Select the lead/activity fields you want to display as a part of the section (e.g., First Name, Phone Number, etc.). The subheading text is similar to the header text, where you can change the subheading of a section.

LeadSquared Document Designer

6.3 Text

The Text component allows you to display simple text data on the document. The rich text editor allows you to modify the text as per your preference. You can also add a Table to the document through the Text component.

LeadSquared Document Designer

6.4 Image

This component allows you to display an image in the document. You can mail merge an image type field that’s a part of the lead or custom activity or add the Image URL that’s uploaded to the Images and Documents library.

Once you’ve added the image, you can align it as per your preference.

Note: For images added using the Image URL option, resizing an image will result in the height changing proportionally to the change in width, and vice versa. You cannot adjust the height and width independently of each other.

LeadSquared Document Designer

6.5 Declaration

This component displays your lead’s declaration. We’ve provided a templatized version of a declaration. You can make modifications to the declaration, add lead/activity fields, and change the declaration layout.

LeadSquared Document Designer

Custom Layout

In addition to the templates provided, you can create a Custom Layout for the Declaration by adding Lead and Activity/Opportunity Fields, along with Signature fields. Arrange these fields either side-by-side or one below the other. You can include up to three fields in one row and resize them as needed.

LeadSquared Document Designer

6.6 Line

Lets you add a line break line between different components. You can change the line colour, by picking a colour from the colour picker. Alternatively, you can enter the hex code of the colour of your choice. You can also change the line thickness.

LeadSquared Document Designer

6.7 Footer

Here you can add plain text content (e.g., college address, contact details, etc.) to the document’s footer. The footer also comes with a default line, which you can edit and modify. You can also add page numbers and logos to the footer.

Footer Text
Enter and configure the footer text.

  • Footer Text – The footer display text. Only alpha-numeric characters are supported. You can add up to 50 characters in the footer.
  • Font Family – From the dropdown, select the footer text font.
  • Font Size – Configure the header text font size.
  • Colour – From the colour picker, select the font colour. Alternatively, you can enter the hex code of the colour of your choice.
  • Style – You can also change the text style to Bold, Italics and Underline.

Line
Configure the line present above the footer text. You can change the line colour, by picking a colour from the colour picker. Alternatively, you can enter the hex code of the colour of your choice. You can also change the line thickness.

LeadSquared Document Designer

6.8 Margins & Border

You can add margins and borders to the following components –

  • Section
  • Text
  • Image
  • Declaration
Note: You can add borders and margins to the container that holds the components listed above.
  • Margin – Configure the margin width and dimensions for the selected component. If you want the margin to be applicable on all sides of the layout, against All Sides, toggle the enable icon slider.
  • Border – Set the thickness, style (Solid or Dashed), and colour for the border around the selected component. Choose a colour from the colour-picker or enter a hex code of your choice.

LeadSquared Document Designer

6.9 Other Actions

You can perform the following actions on a component –

  • Move the component up/down.
  • Add a similar component.
  • Delete the component.
  • Add an additional component* on the right. You can add the following components side-by-side –
    • Section
    • Text
    • Image
    • Declaration
  • The document designer auto-saves your progress every 20 seconds.
  • You can also break the page using the Break the Page action.
Note: *You can place any of the components mentioned next to each other (e.g., you can place an Image component next to a Declaration component).

LeadSquared Document Designer

You can also resize the component when you’ve added two components side-by-side.

LeadSquared Document Designer

6.10 Preview Document

You can preview the document anytime during the document creation process. Click Preview, and select a lead whose details are visible on the document.

LeadSquared Document Designer

 

7. Publish the Template

Once the document is ready, publish it to your account.

Note: Before you publish the document, ensure the following activity fields are added to the Custom Activity on which you’re setting up the document –

  • A String type field.
  • A Custom Field Set (CFS) field, with the Type set to File, and the File Type set to PDF.
  1. On the top-right corner, click Publish.
  2. On the Publish Template pop-up, select the following –
    • Store the document – From the dropdown, select the CFS PDF type field you’ve integrated with the custom activity. Once generated, the document is stored in this CFS field, from where the lead can view and download the document.
    • Document generation status – From the dropdown, select the String type activity field that’s part of the custom activity. The document generation status is stored in this field.
  3. Once you’re done, click Publish.

LeadSquared Document Designer

Once the document is published, a webhook URL and token value are generated. Use these URLs to set up the automation in the next step.

LeadSquared Document Designer

 

8. Set up the Automation

This automation is set up using the custom activity as the trigger. Every time the activity is posted, the webhook URL (which was generated after the document was published) generates a document for the lead.

Note:

  • In this section, we’ve chosen an Activity trigger, but you can set up the automation using a lead, activity, or opportunity trigger. The steps listed below will remain similar for all three entities.
  • If you choose an activity trigger, you can integrate only an activity-based document template with the automation. Likewise, if you select a lead or opportunity trigger, you can integrate only a lead-based or opportunity-based document template with the automation.
  1. Navigate to Workflow>Automation, click Create Automation, and select New Activity on Lead as the trigger.
  2. From the Select an activity dropdown, choose the custom activity you created, and click Save.
    • Disable the “Run Only Once Per Lead” setting.*
  3. Click Add Automation, and under Custom, click Webhook.
  4. On the Webhook pop-up, enter the following details –
    • Name – Enter a relevant name for the webhook. We’re calling it “Document Generation”.
    • URL – Select the method as https://, and paste the connector’s webhook URL that was generated. Before you paste the URL, ensure you remove “https://” from the URL.
    • Content Type – Select application/json.
    • Save Response – You can select either Yes or No.
    • Custom Headers – Click Add, and enter the following details that were generated in the previous step
      • Name – Enter the name (“templateToken”) present under Custom Headers.
      • Value – Enter the value present under Custom Headers.
    • Notify on Failure – Select which user you want to notify if the webhook fails.
    • Retry Count – The number of times you want to retry when the webhook fails.
  5. Once you’re done, click Save, and then click Publish.

Each time the automation is triggered, the webhook generates a document, and this file is stored in the CFS PDF-type field within the custom activity/opportunity.

Note:

  • *It is recommended you disable the “Run Only Once Per Lead” setting when selecting the automation trigger. This is to ensure the automation triggers even when the lead is looking to generate a document multiple times.
  • To know more about the Webhook action, refer to User Automation Actions – Webhook.

LeadSquared Document Designer

 

9. Manage Templates

Once the document template is published, you can perform the following actions from the Manage Templates screen –

  • Copy Webhook URL – This lets you copy the webhook URL directly from the dashboard screen.
  • Clone – This lets you clone the entire template.
  • Rename – This lets you change the internal display name.
  • Live Edit – This lets you make changes to a live document template, without having to unpublish the template.
  • Tags – This lets you add tags to the templates created in your account.
  • Unpublish – This lets you unpublish the template.
  • Delete – This lets you delete the template.
  • Version History– Automatically displays the version number of the template, and displays the name of the user that made the changes to the template.

LeadSquared Document Designer

 

10. Tags

Ease internal document identification for your users by adding tags to each of the document templates you’ve created. Users can also filter and search by the tags assigned to a template.

For example, if there’s a university with multiple campuses, create a tag with the Category set to Campus 1. Then, create a list of tag Values corresponding to the courses offered in that campus, such as Science, Commerce, and Arts. Assign the appropriate tag to the relevant document template.

10.1 Create Tags

  1. On the Manage Templates screen, click the Tags button LeadSquared Document Designer.
  2. On the Filter By Tags pop-up, click Manage all Tags.
  3. On the Manage Tags screen, click New Tag Category.
  4. On the Create Tags pop-up, enter a relevant Category (Campus 1 in our example) and add relevant Values (Science, Commerce and Arts in our example).
  5. Once you’re done, click Save.t

Note:

  • You can add up to 20 tag categories.
  • Under a category, you can add up to 50 values.

LeadSquared Document Designer

10.2 Assign tags

  1. On the Manage Templates screen, hover your cursor over LeadSquared Document Designer, and click Tags.
  2. On the Tags pop-up, from the list of options available, Select Tag Category and Select Tag Values.
  3. Once you’re done, click Add, and then click Save. The selected tags will be added to the template.

LeadSquared Document Designer

 

11. Next Steps

When the automation fires, the document is generated and stored in the CFS PDF-type activity field. To display the document to your leads, you must include the CFS PDF in the Portal

Note: If you’re unable to integrate the CFS field with your portal,  please contact documentdesigner.support@leadsquared.com.

 

Any Questions?

Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!

Integrate Consent Management App with LeadSquared

1. Feature Overview

When you collect sensitive information about your leads (as part of KYC processes, etc.), which may include their identification documents, address proof, credit score, etc., you need to receive consent from the lead to collect this data. Recording the lead’s consent is helpful for audits and lets you stay compliant with government rules and regulations.

Once you integrate the Consent Management App with LeadSquared, you can use LeadSqured Dynamic Forms to trigger a consent approval email to collect sensitive data belonging to the lead. If the lead provides or denies their consent, it will be captured as an Activity on the Lead Details page.

consent management demo

 

2. Prerequisites

  • You must be the Administrator of your LeadSquared account to install and configure this connector.
  • This is a paid feature. To enable it, reach out to your account manager, or write to support@leadsquared.com.

 

3. How it Works

First, install and configure the Consent Management connector. Then, create a Dynamic Form to facilitate the actual consent approval from your leads. You can use Form Rules to trigger the consent approval and map the response from the lead as an Activity.

The Consent Management App requires the following steps –

  1. Install and configure the Consent Management connector
    1. Create a consent purpose and enter the relevant details (Consent Name, Consent Text, Company Logo, etc.,). You can create multiple consent approval flows to maintain approvals for different KYC/document collection processes.
    2. Map the Lead Field with the Email ID Attribute. This mapping is required to send a consent approval email to the lead.
  2. Create a Dynamic Form to trigger the consent approval 
    1. Add the lead fields to the Form.
    2. Use the Initiate Lead Consent details from the Consent Management connector to create a Form Rule on this Form. This rule is used to trigger the consent management process.
    3. Publish the Form.

 

4. Install the Connector

  1. From your LeadSquared account, navigate to Apps>Apps Marketplace.
  2. Search for Consent Management, and click Install.
    • Alternatively, you can find the connector on the left panel, under Verifications.
  3. Once installed, hover your cursor over , and click Configure.

consent management install

 

5. Configure the Connector

Click on Consent management add to add a Consent Purpose. The configuration has two steps –

5.1 Page Configuration

You can enter the following details on your Consent Page Configuration –

*Mandatory fields.

Page Configuration Field Description
Consent Name* Name of the consent capture configuration.
Consent Purpose* Purpose of the consent collection from the lead. There is a 100 character limit to this field.
Company Logo* Your company’s logo. This logo will be visible on the consent page UI.
Primary Colour* Enter a Primary Colour as a hex code – you could match the colour of your company branding
Consent Text* The consent approval text displayed to the lead. There is a 500 character limit to this field.
Link to Terms & Conditions Link to the Terms & Conditions page of your company.
Support Email Address Your company’s support email address. This address will be shown to the lead when they withdraw their consent.

To take a look at how your landing page will look, click Preview. Once you’re satisfied, click Next.

Consent management app configure 1

5.2 Communication Configuration

Configure the consent communication and mapping.

5.2.2 Consent Posting

Choose where the consent activity should be posted: at the lead level or for a specific opportunity.

For instance, selecting Lead will apply the consent to the lead and all subsequent opportunities associated with it. On the other hand, selecting a specific opportunity will restrict the consent to that particular opportunity only.

consent posting lead or opportunity

5.2.3 Communication Mode

The consent communication can be sent via either Email or SMS.

Note: You can enable only one method at a time—Email or SMS, but not both.

Email

When the Email option is enabled, you can map the email to be sent to an entity field in either a Lead or an Activity under the Email Mapping section.

Note:

  • For Lead and Opportunity, the entity field must support the Email data type.
  • If Activity is selected as the Entity in Email Mapping, the supported data type must be String.

consent management email communication

SMS

When the SMS option is enabled:

  1. Map the SMS to an entity field in either a Lead or an Activity under the Mobile Number Mapping section.
  2. Configure the SMS Connector’s X-API Key and SMS Template ID, as provided by your telephony/SMS provider.
    • For example, if you’re using Gupshup, you can find the X-API Key under the Advanced tab on the configuration screen in LeadSquared (it will be visible once when you generate the key). Additionally, ensure that you whitelist your APIs and country code in the Whitelist section.

finding the sms x api key and whitelist ips

  1. In the Map Template Variable section:
    • Map the Reference Number (OTP) as var1.
    • Map the Consent Capture URL as var2.
    • Note: When creating the SMS template, the category must be set to OTP, and Source Availability must be Send API.

configuring sms template for consent management

Review the SMS Template’s Rendered View to ensure proper mapping.

Note: 

  • For Lead and Opportunity, the entity field must support the Phone Number data type.
  • If Activity is selected as the Entity in Phone Number Mapping, the supported data type must be String and must follow the +91-xxxxxxxxx format.

consent management sms communication

Once done, click Save.

Note: When saved –

  • The configuration for Consent Setup and Consent Posting is locked.
  • Only the Company Logo and Primary Color can be modified on the first page.
  • Changes to the Consent Posting Entity (Lead, Opportunity) are no longer allowed.

5.3 Initiate Lead Consent

Once the Consent Management App is successfully configured, the Initiate Lead Consent API details are generated. This internally created API is used to trigger the consent approval process. Copy Copy these API details and use them to create a Form Rule. For more information, refer to the Create a Dynamic Form section.

Note:

  • consenterName is a mandatory parameter.
  • consenterID, consenterAddress, and customIdentifier are Optional. These fields can be mapped in the form and serve as identifiers for the consenter, the individual providing consent, or the reason for obtaining consent.

initiate consent

5.4 Trigger Multiple Consent Processes

You can trigger multiple consent processes. For example, you can create a consent process to perform KYC and a separate consent process to fetch CIBIL Scores. You can define the Consent Purpose for each process. The Consent Purpose will be visible to the lead on the consent email and on the Consent Capture Link.
consent management multiple trigger config

 

6. Create Custom Lead Fields for the Form

Before you configure a Form to initiate the consent approval process, create the following lead fields –

Note: To know how to create lead fields, refer to How to Create Custom Lead Fields.
Custom Lead Field Description
Trigger Consent Approval Create a consent approval trigger to trigger a consent email to the lead. Set the Data Input Type to Dropdown or Boolean, and add the options Yes or No.
Response This field will capture the response once the API is triggered. Set the Data Input Type to Text.
Status This field will capture the status of the consent approval from the lead –

  • INITIATED – Consent has neither been given nor denied.
  • ACTIVE – Consent is given.
  • DENIED – Consent is denied.

Set the Data Input Type to Text.

Consent Capture Link This field will display the URL of the consent capture landing page sent to the lead. Set the Data Input Type to Text.

consent management custom fields

 

7. Create a Dynamic Form for the Consent Approval Process

Note: If you’re new to the Forms and Processes feature, see How to Create a Form. This section assumes you have some familiarity with setting up forms and form rules.

Create a Dynamic Form and add the Custom Lead Fields.

Consent management fields form

Next, create a Form Rule for the trigger field. This is set up using the following example rule –

If ‘Trigger consent process to collect Aadhaar details’ is true,
Then Set Value of Field ‘Consent Approval Response’, ‘Consent Approval Status’, and ‘Consent Capture Link’ using Data From API – POST <API URL, post data obtained from Initiate Lead Consent> and map the specific response parameters to set the field values.

consent management form rules config

Once a consent email is generated, the consent capture link will expire 72 hours (3 days) after being generated. If a response has not been captured in this time frame, then a new consent email will need to be triggered.

consent management capture link

Note: You can trigger multiple consent processes through a single Dynamic Form.

consent management multi-trigger

 

Next Steps

When you’re done, Publish the form. Next –

 

Any Questions?

Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!

Automation Best Practices

1. Feature Overview

This article will help you understand the best practices to follow when configuring and running your Workflow Automations on LeadSquared.

 

2. Prerequisites

  • You must be the Administrator of your LeadSquared account to create and configure an Automation.
  • Automation is a paid feature. To enable it, reach out to your account manager, or write to support@leadsquared.com.

 

3. Best Practices to Avoid Automation Failure

Most automation failures are due to configuration errors that might have occurred when setting up the automation. Here are a few points to keep in mind during the configuration process – 

1. Send Email Action

When usingSend Email action, make sure the email address of the lead field has a valid email address. Navigate to Manage Leads>Lead Details to edit or verify the lead’s email address. 

automation email id check

Also, make sure the Do Not Email flag is disabled (“No“) for the lead. To find this option, navigate to Manage Leads>Lead Details Page>Lead Details Tab.

automation do not email

2. Mail Merging an Empty Field to a Mandatory Field

When mail merging a field to a mandatory field, make sure it is not an empty field. For example, if you mail merge the Last Name lead field, the Last Name lead field must contain a value (e.g., Smith, etc.). Fields marked with “* are mandatory.

automation last name

3. Mail Merging an Empty Date Field in Schedule Field for Create Task Action

On the Create Task Action, when you are mail merging a date field in the Schedule field, the date field must contain a value. For example, if you mail merge Application Submitted On as the date field, this field will need to have a value on the Lead Details page.

automation create task schedule

4. Mail Merging a Field with Invalid Data Type

When mail merging a field in automation, make sure it is a valid data type. For example, when you are mail merging the Age lead field, make sure the Data Input Type is a Number (and not Text, Boolean, etc.).

automation data type

5. Deleting a Field Configured in a Published Automation’s Advanced Search Condition

If you have configured a field through the advanced search condition and published the automation, make sure to edit the field in the automation when deleting the particular field.

For example, if you have configured ID Proof as a Custom Activity Field through the advanced search condition, and if you are going to delete the Custom Activity Field in the future, make sure to edit this field in the published (live) automation.

automation delete field

 

2. Common Reasons for Call Lapp and Webhook Failure

Here are some reasons why your Call Lapp or Webhook might be failing –

1. API Rate Limit Exceeded

The API Rate Limit is a configurable limit and varies for different accounts. Ensure you’re not exceeding the rate limits configured on your account.

For example, if your API Rate Limit is five per second, but you have exceeded this number, then you will receive a 429 error. You can view your API Limits by navigating to Settings>Profile>Billing and Usage.

automation api rate exceed

2. Gateway Timeout

When the automation calls a Lapp or a Webhook, it’ll wait for a response for 30 seconds. If there is no response from the Lapp or Webhook within this time frame, it will throw a 504 Gateway Timeout error.

automation gateway timeout

3. Incorrect API URL

If the API URL you’ve configured is not valid, the automation will throw a 403 error. For example, the API could have been valid at the time the automation was published, but if there are any changes made to the API after the automation was published, then your endpoint might not be valid anymore.

automation api url

 

3. Best Practices for Increasing Automation Efficiency

There are certain pointers to keep in mind if you want to increase the efficiency (execution count) of your automation workflow –

1. Add Additional Conditions in Advanced Search on Each Trigger

Instead of adding an If/Else condition on a trigger, you can add the condition in the trigger itself.

For example, you might want the automation to trigger on lead creation, and run for leads whose City is Mumbai. Instead of adding an If/Else card on the trigger for the City, you can include the City on the trigger itself.

automation inclusion criteria

2. Use “Multi If/Else” Over Multiple “If/Else” Conditions

If you have to configure multiple conditions, it’s more efficient to use a Multi If/Else, instead of adding different If/Else conditions.

multi if else example

3. Reduce the Retry Numbers on Call Lapp and Webhook

When you configure a Call Lapp or a Webhook, you can also specify the number of retries the automation can attempt if it fails while being called. The maximum number of retries you can configure is 3 and the minimum can be left at 0. The automation will wait five minutes before each retry.

To increase the efficiency of the automation, it’s best to set the Retry Count to either 0 or 1.

automation retry count

4. Select Criteria to Exit Automation

Use the exit criteria advanced search to stop automation execution in hard-stop cases. For example, If Lead Stage is Not Interested or Invalid, you do not need the automation to run for that lead anymore. 

automation exit condition

 

Any Questions?

Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!