Push template - carousel

A notification that shows a series of three to five images that scroll on/off the sides of the notification.

If operating in automatic mode, images will rotate every five (5) seconds. If operating in manual mode, the user is required to push a button to advance forwards or backwards through the carousel.

Templates below show all available properties in their respective payloads for FCM (Android) and APNS (iOS). FCM

fcm

Properties

The properties below define the payload sent to FCM:

Example

Default Manual Carousel:

Filmstrip Manual Carousel:

Automatic Carousel:

Below is a sample of what a payload might look like for a carousel notification:

{
  "message": {
    "token": "FCM_TOKEN",
    "android": {
      "collapse_key": "new message"
    },    
    "data": {
      "adb_version": "1",
      "adb_template_type": "car",
      "adb_title": "Check out the new line of shoes!",
      "adb_body": "Hot deals on new releases!",
      "adb_sound": "sneakerSqueaker",
      "adb_small_icon": "chat_bubble",
      "adb_large_icon": "https://sneakerland.com/logo.png",
      "adb_uri": "https://sneakerland.com/newReleases",
      "adb_a_type": "WEBURL",
      "adb_body_ex": "We have some new inventory we think you'll like.",
      "adb_clr_body": "00EE00",
      "adb_clr_title": "AABBCC",
      "adb_clr_icon": "123456",
      "adb_clr_bg": "000000",
      "adb_car_mode": "auto",
      "adb_car_layout": "default",
      "adb_items": "[{\"img\":\"https://sneakerland.com/products/shoe1/shoe1.png\",\"txt\":\"Shoe 1 by Cool Sneaker Brand\",\"uri\":\"https://sneakerland.com/products/shoe1\"},{\"img\":\"https://sneakerland.com/products/shoe2/shoe2.png\",\"txt\":\"Shoe 2 by Lame Sneaker Brand\",\"uri\":\"https://sneakerland.com/products/shoe2\"},{\"img\":\"https://sneakerland.com/products/shoe3/shoe3.png\",\"txt\":\"Shoe 3 by Average Sneaker Brand\",\"uri\":\"https://sneakerland.com/products/shoe3\"}]"
    }
  }
}

Usage recommendations

The tables below contain guidelines for your push notification content. These recommendations help your text and images display reliably across multiple devices. These values are guidelines only - you should still test a notification prior to sending it.

Audio specifications

Custom sound files must be placed within the app's bundle in the res/raw directory. Supported formats are mp3, wav, or ogg.

Image specifications

Text guidelines

APNS

apns

For full information on APNS payload keys, see Apple's documentation.

The properties below define the payload sent to APNS:

APNS properties

AEPNotificationContent properties

Example

Below is a sample of what a payload might look like for a notification using a carousel template:

{
    "aps" : {
        "alert" : {
            "title" : "Your Perfect Beach Holiday 🏖️",
            "body" : "Play, Relax, Recharge. Book your beach escape now!"
        },
        "mutable-content" : 1,
        "category" : "AEPNotification"
    },
    "adb_template_type" : "car",
    "adb_version" : "1.0",
    "adb_car_mode" : "manual",
    "adb_body_alt" : "Book your vacation now! 🏖️",
    "adb_items" : [
        {
            "img" : "https://<URL_CONTAINING_FIRST_IMAGE>",
            "txt" : "Escape to unique, undiscovered spots for a relaxed, memorable adventure away from the usual crowd.",
            "uri" : "myapp://book/beachPackage1"
        },
        {
            "img" : "https://<URL_CONTAINING_SECOND_IMAGE>",
            "txt" : "Nothing beats the joy of playing on the beach during vacation, where every wave brings a smile and the sand castles rise as memories are made.",
            "uri" : "myapp://book/beachPackage2"
        },
        {
            "img" : "https://<URL_CONTAINING_THIRD_IMAGE>",
            "txt" : "At sunset, the beach buzzes with playful silhouettes against the fading light, laughter mingling with the sea's whispers.",
            "uri" : "myapp://book/beachPackage3"
        }
    ]
}

Usage recommendations

The tables below contain guidelines for your push notification content. These recommendations help your text and images display reliably across multiple devices. These values are guidelines only - you should still test a notification prior to sending it.

Image specifications

Text guidelines