This documentation helps you integrate your Netcore CE dashboard with LimeChat. Use the events data to create WhatsApp flows on LimeChat based on specific activities tracked by us. Leverage event payload, contact attributes, and custom parameters to customize WhatsApp messages and use two-way gamification to improve customer experience on WhatsApp. This lets you get the best possible conversion for your abandoned carts, upsells, or cross-sells.

To set up and use LimeChat, you need to go through the following three major phases:

1. Prerequisites
2. Activate LimeChat Integration
   • API key
   • Account ID
3. Access LimeChat in Journeys

Prerequisites

Ensure the following prerequisites are fulfilled to enable this integration.

1. Confirm you have an active LimeChat account.
2. Access to your LimeChat API keyand Account ID. Refer to this document to access your LimeChat API keyand Account ID.

Access LimeChat API Key

Follow these steps to get LimeChat API key.

1. Login to your LimeChat account.
2. Navigate to User Profile > Profile Settings>API key to access the LimeChat API key.
3. If you don't already have an API key, click the Generate New Key button. Ensure you save it somewhere, as it won't be visible again.

Note: If you create a new API key, the older API key will be inactivated.

Access Account ID

Follow these steps to get LimeChat Account ID.

1. Login to your LimeChat account.
2. Navigate to Account Profile > account_id to get the LimeChat Account ID.
3. Copy the Account_id from the ID section.

Activate LimeChat Integration on Netcore CE

Follow the steps below to enable LimeChat Setup on Netcore's CE dashboard.

1. Log in to the Netcore CE dashboard and navigate to Settings > Integrations > LimeChat

📘

Note

Only one LimeChat integration can be active on Netcore's CE dashboard.

2. Click ADD INTEGRATION.
3. Provide the Connection name, API key, and Account ID.
4. Click on TEST CONFIGURATION to verify the LimeChat credentials and send a test event. If successful, the ACTIVATE button will be enabled and an event by the name of "netcore test event" will be available on LimeChat.

🚧

Error in Test Configuration

If the TEST CONFIGURATION is not verified, ensure the correct credentials (API key and account ID) are entered.

5. Click ACTIVATE.

📘

Note

After successful ACTIVATE, you'll be able to access LimeChat in your Journeys under Actions section. LimeChat is applicable on Activity, List, Segment, or Triggers.

View LimeChat Integration

Follow the steps below to view LimeChat on the Netcore CE dashboard.

1. Log in to the Netcore CE dashboard and navigate to Settings> Integrations> Connected.
2. Navigate to the active LimeChat connection to View.
3. Click and select View.
4. You'll be able to View the configured Connection name, API key, and Account ID.

Note: An active connection cannot be edited. Please contact our support team to edit or remove an active LimeChat connection.

Access LimeChat in Journeys

After successful activate LimeChat setup, you'll be able to access LimeChat in your Journeys under Actions section. LimeChat is applicable if Activity, List or Segment supported Triggers or Wait for event action node exists.

Enter the following details to configure the LimeChat node in Journeys.

1. Enter Node name, and the data flow will be automatically selected.
2. Select User attributeswhen you want to personalize messages as per requirement.
3. Toggle on Set attribute labels, and modify Attribute Labels.
4. Toggle on Custom key value and enter Key and Value details to send custom requirements to LimeChat.
5. Click SAVE.
6. Click ACTIVATE to activate the journey and start sending data.

📘

For Lists and Segments

While exporting List or Segment, the name of the event sent to LimeChat will be same as the List or Segment name. We will send one event of that name for every user in the List or Segmet.

Journey Report Export

Follow the steps below to export Node wise Journey Report.

1. Log in to the Netcore CE dashboard and navigate to Engage > Journey.
2. Select Journey where LimeChat is configured.
3. Select Node wise report and hover on the LimeChat box to view Sent, Success and Failed report as per Performance period requirement.

Frequently Asked Questions

Q. How do I get the Limechat API Key?

A. Follow these steps to get the LimeChat API Key:

• Login to your LimeChat account.
• To access the LimeChat API Key: Profile>Profile Settings>API Key.
• If you don't already have an API Key, click on the Generate New Key button. Save that, as it won't be visible again.

Q. How do I get the Limechat Account ID?

A. Follow these steps to get a LimeChat Account ID:

• Login to your LimeChat account.
• To access the LimeChat API Key: Profile>Account Settings>account_id.
• Copy the account_id from the ID section.

Q. How do I troubleshoot if the integration isn't working?

A. Ensure the API credentials are correct and match the values in your Limechat account. You can also check for errors or limitations imposed by Limechat’s rate limits or payload size restrictions.