Mobile App Custom Keys

Overview

You can add custom key/value pairs to your push notification payload that will trigger a wide range of unique app experiences and give you more push message personalization options. Each key/value pair will enable specific app functionality designed by your app developers and you can add as many as required.

• Personalize the look and feel of your app for individual contacts
• Conditionally display content for different groups of contacts
• Pass tracking data for testing and analysis
• Preserve app functionality during SDK migration
• Play a custom notification sound

Custom keys defined at the channel level will be available across all push messages automatically and can be edited uniquely for every message during message creation.

Creating Custom Keys

You can save a set of default custom keys via the UI. Log in to your Cordial account and open the dropdown menu in the top right corner. Navigate to Account Settings and select Push (or your custom push channel label) from the left navigation menu.

Edit the Custom Keys section to add new or modify existing key/value pairs. The value field accepts contact and system Smarty variables such as {$contact.attributeKey} and {$mcID}, giving you access to additional data for analysis and message personalization.

• Key - A unique identifier for the data within the value field
• Value - Carries data associated with the key or points to the location of other data

Custom Notification Sound

Using custom keys, you can specify a sound file to play when the notification arrives on the device. You will need to specify a file for each applicable platform and include the full filename to be played.

Editing Custom Keys

It is possible to edit default custom keys during message creation. Changes made at the message level will not update saved custom key/value pairs at the channel level.

During message creation, locate the settings for Custom Keys and click Edit. You can now edit custom keys unique to the message.