Integrate with CleverTap

Sendbird Business Messaging allows you to integrate with CleverTap, a multi-channel marketing tool. To send notifications using CleverTap, you must install Sendbird Business Messaging Builder, a Chrome extension that provides a user-friendly interface for sending notifications. Select CleverTap on the Integrations page under Business Messaging on Sendbird Dashboard to start setting up.

Note : Before integrating with CleverTap, you need to create a template on Sendbird Dashboard first.

To view the image in full screen, click on the

To set up your CleverTap integration, turn on the Event callback option and fill in the Project ID, Passcode, and API endpoint.

When the following information is entered and saved, the CleverTap integration is added to your Sendbird Dashboard.

Install Sendbird Business Messaging Builder as a Chrome extension. You can also find the extension link on Business Messaging > Integrations > CleverTap in Sendbird Dashboard. Once installed, click on the Sendbird Business Messaging Builder extension on your Chrome browser and click Go to Settings. On the settings window, you need to add your App ID and API Token in order to load the created templates to the Sendbird Business Messaging Builder.

CleverTap creates a user profile for each person who uses your client app. User profiles have a set of default fields, such as email, phone number, and language. But you can also add more identifiers to the user's custom attributes. In order to map a Sendbird user ID to a CleverTap user ID, you need to add a Sendbird user ID as a custom identifier. Refer to the example code for CleverTap's Android SDK below.

HashMap<String, Object> profileUpdate = new HashMap<String, Object>();
profileUpdate.put("SendbirdID", "<Sendbird User ID>");

cleverTap.pushProfile(profileUpdate);

To learn more about updating the user profile, see CleverTap's documentation guide.

If you've turned on the Event callback feature on Sendbird Dashboard, a notification's delivery receipt and read receipt events can be integrated with CleverTap's custom events. When an event takes place in a Sendbird channel, the Sendbird server uses CleverTap's upload events API to create an event in CleverTap. The following is a JSON payload example of the callback. You can track the message's conversion rate with the value in the status field.

{
  "evtName": "My First Campaign", // The Event name value you’ve set in Editor
                                  // during the notification creation.
  "evtData": {
    "status": "READ",             // The status of a notification. Either SENT
                                  // or READ.
    "target_id": 123123           // The campaign or journey ID.
  }
}

Before sending any notifications through a Campaign or Journey, you need to add a webhook template on the CleverTap Dashboard under Settings > Engage > Channels > Webhooks in order to send a notification through Sendbird. Sendbird supports two different endpoints for sending notifications through the CleverTap integration, which are realtime and batch. The following table compares the different use cases between the realtime and batch endpoints.

Once you decide which endpoint you want to use, select the + Add Webhook button and fill in the necessary information.

You can now send a notification on the CleverTap dashboard. Select Sendbird as the Messaging Channel when creating a new Campaign. When creating a new Journey, select Webhook as the Messaging Channel. Then under Webhook, choose the webhook template for Sendbird. You can now go to the Editor page and select the template you created on Sendbird Dashboard to send your notification.