In-App Messages

Overview

As of October 29, 2018, we have released a new and improved in-apps with crisper message rendering capability which provides the capability to send in-app messages with images, GIFs, video, and audio. You can also do A/B testing on your in-apps.

🚧

SDK Version

To use the template-based in-app campaigns, update your app with the CleverTap SDK version 3.3.0 or above.

A/B test does not need an SDK update. You can still send an A/B test on any SDK (including version below 3.3.0) version as long as all the variants are HTML templates.

Create In-App Messages

The following section shows how to create various types of in-app messages.

Create a Campaign

  1. Navigate to Messages > Campaigns.
  2. Click on + Campaign.
  1. Select Mobile In-app from the channel selection page.
  1. Select the start date and time of the campaign as well as the end date and time.
  2. Click Continue.

πŸ“˜

Recurring Day

If you specify a recurring day for a campaign such as the 7th of each month, the campaign will start for the specified day and ignore the creation date. This is a precaution to avoid sending a campaign unintentionally on a prior date.

  1. You must indicate the target audience for your mobile in-app campaign. You can target your in-app campaign to a new user segment by clicking on + Create an ad-hoc segment or use a previously saved user segment from the Saved Segments list.

Once done, follow the steps from one of the sections below:

HTML In-Apps

This section shows the steps for HTML in-app campaigns.

  1. Select one of the following message types:
  • Single message
  • A/B test
  • Message on user property
  1. Select any or all of the following device types:
  • iOS
  • Android
  • Mobile
  • Tablet
  • TV (Android)
  1. Select the Custom HTML template.

🚧

SDK Version and Typeform

Other templates are only supported on SDK versions 3.3.0 and above.

We do not currently support Typeform because its rendering requires access to local storage which is a security risk. CleverTap SDK WebView does not allow access to local storage.

❗️

Source Event Property

The CleverTap source event property is not supported for web pop-up and mobile in-app campaigns.

  1. Choose the builder option to create HTML in-apps via a drag-drop method. As an alternative, you can also choose to use the Custom HTML option to build your own campaign.

πŸ“˜

Create Interactive In-Apps

You can create interactive in-app campaigns such as scratch card campaigns and swipe interaction campaigns using JavaScript.

Using the Custom HTML option, you can use Javascript in the HTML and create deep interactive in-app campaigns by adding the JavaScript code along with the HTML code.

Note: JavaScript-based campaigns are available on version 3.5.0 and above.

Native In-Apps

This section shows the steps for native in-app campaigns.

  1. Select one of the following message types:
  • Single message
  • A/B test
  • Message on user property
  1. Select any or all of the following device types:
  • iOS
  • Android
  • Mobile
  • Tablet
  • TV (Android)
  1. Pick any template.

Since your entire user base is on SDK version 3.3.0 and above, you can select any of the templates or Custom HTML template.

You must choose the canvas size and type before you start creating the message. The campaign canvas provided by default are the following:

  1. Build the in-app message by entering all the necessary information.

🚧

Character Limit

The character limit for a message in English is 30 for the title and 128 for the message.
The character limit for a message in Chinese is 9 for the title and 38 for the message.

4a. Select Personalize media to personalize in-app messages.

This option helps to create recommendations in-apps and to upload personalized images for each of your users.

4b. Select On click action.

Mobile in-app enables various types of call-to-action (CTA) to cater to different use cases for clients, such as the following:

  • Close notification: It closes the notification after a tap.
  • Open URL: A special type of CTA that enables the user to open a deeplink for Android or iOS.
  • Custom key-value pairs: The key-value pairs send back custom data when a user clicks the in-app button. This data is not visible to the user. This feature is available for apps that use Clevertap Android SDK version 3.6.1 or above and iOS SDK version 3.7.1 or above.
  1. Pick the media for each orientation while noting:
  • Using the background option in in-app, you can choose the media that you want your end-users to see when the app is in portrait mode and in landscape mode.
  • You can choose to add the same image with different form factors or completely different images to give a unique experience on portrait and landscape.

Users on New and Old SDK Versions

🚧

Users on Both Old and New App Versions

The information provided below is for customers whose entire audience has not updated their app to support the native in-app capability.

Post releasing the app update, there will be users who will be on both old and new app versions. In this case, to send a campaign to both your user base, follow the steps below.

You will not be able to use the A/B test and message on user property with this option.

Depending on your SDK version, use one of the following steps to create in-app campaigns:

New Version (SDK 3.3.0 and Above)

This section shows the steps for in-app campaigns with the new SDK.

  1. Select New in-app if you are using a new version.

Legacy Version (SDK 3.2.0 and Below)

This section shows the steps for in-app campaigns with the old SDK.

  1. Select Legacy In-app if you are using an old SDK version.

Template Aspect Ratio and Image Size Guide

Follow this guide while creating in-app messages:

Canvas Type

Canvas Aspect Ratio

Sample Image Sizes

Image Type Supported

Cover

Full Screen

Screen Resolution

Image

Interstitial

1.78:1

16:9

Image, gif, audio, video. GIF file type is supported only for images with content notification.

Half Interstitial

1.30:1

4:3

Image

Header

Height: 1:1
Width: Fit to screen

N/A

Logo Image

Footer

Height: 1:1
Width: Fit to screen

N/A

Logo Image

Native Alert

Native

N/A

N/A

Image Only Template

When selecting an image only template, you can send a message which only contains an image (without CTAs and/or title and/or message).

With Content Notification

When selecting a With Content Notification template, you can send a message with a background image, title, message, and CTAs.

πŸ“˜

Image Cropping

Due to the multiple phone sizes on both Android and iOS, we will center crop images if the image does not fit the screen resolution.

We scale the image uniformly (maintaining the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the phone (minus padding). The image is then centered in the view.

Video Tutorial

For further information, you can watch the following video on in-app message:

FAQs

I need to send an A/B test and multivariant campaigns. Do I need to update my SDK?

  • No, you do not need an SDK update.
  • You can create a custom HTML campaign for all your variants.
  • You cannot send template campaigns in that case.

I need to send crisp template campaigns. Do I need to update my SDK?

  • Yes, the new and improved templates only work with SDK version 3.3.0 and above.
  • You cannot send these campaigns on SDK versions below that.

My partial user base is on an old SDK and the rest are on new. How do I send them the same campaign?

  • To send a campaign, you will have to pick the legacy option.
  • This will open two variants of the campaign.
  • The New In-App will send the campaign to users on SDK version 3.3.0 and above.
  • The Legacy In-App will send the campaign to users on SDK version 3.2.x and below.
  • This legacy option will be available until March 31, 2019, and will be deprecated after this date.

When should I use the custom HTML builder?

  • If you have not upgraded to the SDK version 3.3.0 or above, your users will not receive the template-based campaigns. In this case, you will have to use the custom HTML builder.
  • If the templates provided (Cover, Interstitial, etc.) do not meet your business use case, you can create your own HTML.

How does my image get cropped?

  • We follow the center crop.
  • We scale the image uniformly (maintaining the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the phone (minus padding). The image is then centered in the view.

What size of media can I use?

  • Image: Less than 500 kb.
  • Audio: Less than 5 Mb.
  • Video: Less than 50 Mb.

What is the character limit for my message?

Language

Title

Message

English

30

128

Chinese

9

38

What is the Time to Live (TTL) for my message?

The default value for TTL is two days. You can define the TTL for a maximum of 28 days.

Sample Images

Below is a list of sample images, such as:

Updated 5 months ago


In-App Messages


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.