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:
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:
- Select Integrations from the top navigation of your Yellow.AI dashboard.
- Search for CleverTap under All Integrations section on the left.
- Click API Key to copy the key and save it for future use.
- Click Endpoint URL to copy the endpoint and save it for future use.
Configure CleverTap Dashboard
To configure the CleverTap dashboard:
- Navigate to Settings > Channels > WhatsApp from the CleverTap dashboard.
- Click + Provider and select Generic (Other) from the Provider dropdown.
- 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:
|
- Select the Mark this as default checkbox to make this service provider as the default provider to send a WhatsApp message.
- 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.
- (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.
- Click Save to save the details.
Set Up CleverTap Callbacks in Yellow.AI
To set up the CleverTap callbacks:
- 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.
- Paste the Delivery Report and Inbound Message callback URL:
a. Log in to your Yellow.AI account.
b. Navigate to Engage > More > Preferences.
b. Toggle ON the Postback URL and paste the URL obtained in Step 2 of Find Yellow.AI Details.
c. Paste the Inbound Message Callback URL on the Integrations page of Yellow.AI as shown in the following figure:
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.
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:
- Navigate to Settings > Channels > WhatsApp from the CleverTap dashboard.
- Enter the Provider Nickname in the Search field.
- Select the Templates tab, and click +Template.
- Enter the template name in the Namespace field.
- Choose the type of template header (Text or Media). For Media headers, you can use Image, Video, Document, and Location
- Enter the message content.
- Select Footer to add a footer text and a button (Quick Reply or a Call To Action).
- Select the Language in which you want to display the message.
- Click Save Template.
Test a Message Template
You can send a test message using the saved templates from the CleverTap dashboard as follows:
- Hover over the desired template for which you want to send a test notification.
- Click Send Test WhatsApp.
- Select the test profiles or manually enter the mobile number to whom you want to send the test message and click Send Test.
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:
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.
Updated 11 months ago