🚧

Support For Integration

This integration is completed by Kaleyra, and they are dedicated to maintaining and enhancing it. The CleverTap and Kaleyra integration has undergone stringent testing to ensure seamless functionality. For any support or query resolution, contact Kaleyra.

Introduction

CleverTap users can leverage the following WhatsApp capabilities of Kaleyra to communicate with their customers to:

• Send just-in-time offers to customers to drive purchases
• Gather feedback on the services
• Keep customers informed and more

Prerequisites For Integration

Following are the prerequisites:

• WhatsApp add-on enabled on the CleverTap account in addition to the basic or essentials price plan.
• WhatsApp onboarding for the phone number to be used with CleverTap is completed.
• Kaleyra WhatsApp Business API.

Integrate Kaleyra with CleverTap

This process involves the following three steps:

1. Find Kaleyra Details.
2. Configure CleverTap Dashboard.
3. Set Up CleverTap Callbacks in Kaleyra.

Find Kaleyra Details

We recommend keeping the API key and HTTP Endpoint handy before starting with the configuration on the CleverTap dashboard. To do so:

1. Get the CleverTap endpoint URL from the Kaleyra support team.
2. To get the API keys:
   i. Log into your Kaleyra account.
   ii. From the left menu bar, click Developers. The API Keys page appears.
   iii. Hover over the API key to view the API Key and the SID.
   iv. Click the ellipses icon (...) at the right end of the API Key list and click Edit.

You can view the following details:

• API Name
• Whitelisted IP Addresses: The whitelisted IP addresses for the API Key.
• API Domain: The base URL to send the API requests.
• SID (Security Identifier): Unique SID of your kaleyra account. This value is the same for all your API Keys.
• API Key: API key details.

3. Click the copy icon next to the API Key to copy the API to the clipboard.

Configure CleverTap Dashboard

To configure the CleverTap dashboard:

1. Go to Settings > Channels > WhatsApp > WhatsApp Connect from the CleverTap dashboard.
2. Click + Provider and Log in to Facebook.

3. Enter the following details:

4. To make this service provider as the default provider to send a WhatsApp message, select the Mark this as default checkbox.
5. To automatically reply to users who message on WhatsApp but are not tracked on the CleverTap dashboard, select the Set auto-reply for users not tracked on CleverTap checkbox.
6. (Optional) You can set the Maximum Concurrent API requests anywhere between 30 to 1000 requests. Consider your requirement and the provider's limitations to define this value.
7. Click Save.

Set Up CleverTap Callbacks in Kaleyra

📘

Naming WhatsApp Templates

Template names and language variants must be unique for each provider configuration. This means that you can use the same template name once for each provider configuration.

For example, if you have multiple provider configurations, such as Phone_1, phone_2, you can use the same template name once within Phone_1 and Phone_2.

CleverTap callbacks are already configured in send message API request headers. You must enable a custom callback URL provided by the Kaleyra support team.

To set up the custom callback URL:

1. Log into your Kaleyra.io account.
2. Click user profile in the top right bar,
3. Click Settings.

4. Navigate to the Settings tab

5. In the Enable WhatsApp Callback URLs field, enter the HTTP Endpoint shared by the Kaleyra Support team to configure the WhatsApp Callback.
6. Click Save.

To enable incoming messages callback URL in Kaleyra:

1. Sign in to your Kaleyra.io account.
2. On Kaleyra's dashboard page, click Channels from the left menu bar.
   The Channels page appears.
3. From the WhatsApp section, click Manage. The WhatsApp Dashboard page appears.

4. Click Configurations. The Configurations page appears.

5. Locate the number you have configured in CleverTap > Click the ellipsis > click Edit. The Edit Number pop-up appears.

6. Enter the incoming message URL provided by the Kaleyra Support team in the Incoming URL field.

7. Add the following two query parameters:

• ? followed by inbound_message_callback_url= and paste the Inbound Message Callback URL from the CleverTap's Provider page.
• & followed by payload_version= and then enter the Payload Version in the Body section of the CleverTap's Provider page.

Find Template Details

You need to add the details of your pre-approved templates on the CleverTap dashboard. To find the details of your pre-approved templates on Kaleyra, navigate to the Template section from the Kaleyra dashboard. You can replicate these pre-approved templates in CleverTap to start sending campaigns. Refer to the section below to understand how to add templates in CleverTap.

Add Message Template

To create WhatsApp campaigns, you must have pre-approved WhatsApp message templates saved on the CleverTap dashboard.

To add the message templates:

1. Go to Settings > Channels > WhatsApp > WhatsApp Connect from the CleverTap dashboard.
2. Enter the Provider Nickname in the Search field.
3. Select the Templates tab, and click +Template.

3. Enter the template name in the Namespace field.
4. Choose the type of template header (Text or Media). For Media headers, you can use Image, Video, Document, and Location.
5. You can choose to use the Limited Time Offer template for your message. For more information, refer to Limited Time Offer Template.
6. Enter the message content.
7. Select Footer to add a footer text and a button (Quick Reply or a Call To Action).
8. Select the Language in which you want to display the message.

7. Click Save Template.

Test Message Template

You can send a test message using the saved templates from the CleverTap dashboard as follows:

1. Right-click the ellipsis below the template.
2. Click Send Test WhatsApp.
3. Select the test profiles or manually enter the mobile number to whom you want to send the message and click Send Test.

The success or failure response appears on the dashboard. If the message is not delivered, you can copy the response payload and share it with the Kaleyra team to debug the issue, as shown in the following figure:

Create Campaign

To create a WhatsApp campaign using Kaleyra as the provider, refer to Create a WhatsApp Campaign.

Creating a Journey

To create a WhatsApp journey using Kaleyra as the provider, refer to Create a WhatsApp Journey.