Yellow.AI

Understand how to integrate Yellow.AI with CleverTap for WhatsApp communication.

🚧

Support For Integration

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

Introduction

CleverTap users can now leverage the following WhatsApp capabilities of Yellow.AI to communicate with their customers:

  • Sending just-in-time offers to customers to drive purchases
  • Gathering feedback on the services
  • Keeping customers informed and more

Prerequisites for Integration

The following are the prerequisites:

  • You must have a WhatsApp add-on enabled on the CleverTap account in addition to the basic or essentials price plan.
  • Ensure that WhatsApp onboarding for the phone number to be used with CleverTap is completed.
  • You must have Yellow.AI WhatsApp Business API

Integrate Yellow.AI with CleverTap

This process involves the following three steps:

  1. Find Yellow.AI Credentials.
  2. Configure CleverTap Dashboard
  3. Set Up CleverTap Callbacks in Yellow.AI

Find Yellow.AI Details

We recommend that you keep the API key and Endpoint handy before starting with the configuration on the CleverTap dashboard. To find these credentials:

  1. Select Integrations from the top navigation of your Yellow.AI dashboard.
  2. Search for CleverTap under All Integrations section on the left.
Yellow.AI Dashboard

Yellow.AI Dashboard

  1. Click API Key to copy the key and save it for future use.
  2. Click Endpoint URL to copy the endpoint and save it for future use.
2540

Yellow.AI Credentials

Configure CleverTap Dashboard

To configure the CleverTap dashboard:

  1. Navigate to Settings > Channels > WhatsApp from the CleverTap dashboard.
  2. Click + Provider and select Generic (Other) from the Provider dropdown.
  1. Enter the following details:

Field

Description

Provider

Select Generic (Other) from the dropdown list.

Nickname

Enter the nickname as Yellow.AI to identify the provider easily.

WhatsApp Business Number

Enter your phone number onboarded to WhatsApp API by Yellow.AI.

Request Type

Ensure that the Request Type is POST.

HTTP End Point

Headers

Select Headers under the Body section and enter the following key-value pair:

  • Enter Key as Authorization and paste the API key, obtained in Step 2 of Find Yellow.AI Details, in the Value field
HTTP Endpoint and Headers

HTTP Endpoint and Headers

  1. Select the Mark this as default checkbox to make this service provider as the default provider to send a WhatsApp message.
  2. 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.
  3. (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.
  4. Click Save to save the details.

Set Up CleverTap Callbacks in Yellow.AI

To set up the CleverTap callbacks:

  1. Copy the Delivery Report Callback URL and Inbound Message Callback URL from the CleverTap dashboard. You can find the Callback URLs under the Setup tab of the Provider page.
1078

Setup Callbacks

  1. Paste the Delivery Report and Inbound Message callback URL:
    a. Log in to your Yellow.AI account.
    b. Navigate to Engage > More > Preferences.
1176

Yellow.AI Dashboard

b. Toggle ON the Postback URL and paste the URL obtained in Step 2 of Find Yellow.AI Details.

1608

Postback URL

c. Paste the Inbound Message Callback URL on the Integrations page of Yellow.AI as shown in the following figure:

1800

Setup Inbound Message Callback URL

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 Yellow.AI, navigate to the Template section from the Yellow.AI dashboard, as shown below.

Find Template Details

Find Template Details

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. Navigate to Settings > Channels > WhatsApp from the CleverTap dashboard.
  2. Enter the Provider Nickname in the Search field.
  3. Select the Templates tab, and click +Template.
2174

Create a New Template

  1. Enter the template name in the Namespace field.
  2. Choose the type of template header (Text or Media). For Media headers, you can use Image, Video, Document, and Location
  3. Enter the message content.
  4. Select Footer to add a footer text and a button (Quick Reply or a Call To Action).
  5. Select the Language in which you want to display the message.
2036

Define Template Content

  1. Click Save Template.

Test a Message Template

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

  1. Hover over the desired template for which you want to send a test notification.
  2. Click Send Test WhatsApp.
  3. Select the test profiles or manually enter the mobile number to whom you want to send the test message and click Send Test.
1304

Test a Message Template

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

728

Validate the Test Response

Create Campaign

To create a WhatsApp campaign using Yellow.AI as the provider, refer to Create a WhatsApp Campaign for detailed instructions.

Creating a Journey

To create a WhatsApp journey using Yellow.AI as the provider, refer to Create a WhatsApp Journey for detailed instructions.