Push Notification Template
Overview
Push Notifications are delivered to mobile devices as JSON
messages. This message contains the basic text of the notification, but
it can be used for more advanced features as well. For example, the JSON
message can define the portion of the message that appears within the
"Alert" section of the user's device, or a "deep link"
to open the app to a specific page, or play a video, or show order information.
The Push Notification Template screen provides a JSON editor
that can be used to define a JSON form schema. This form schema is a set
of instructions that determines the appearance and options that are available
when building the content of a Push Notification Campaign. For example,
you can define what fields appear on the Campaign screen, whether those
fields are displayed as freeform text fields
or drop-down menus, whether the fields are optional or required, and what
the default values are. This step is part of the larger process of setting
up the Push Notification channel (see Push
Notification Channel Setup for more details on this process).
Note: The JSON schema must be written in the json-schema format as
described here.
Once you've created the Template, you'll need to assign
it to one or more apps within an Application
Group. The Template will then be available in a Campaign that uses
that Application Group as its Sender Profile.
For more information on the Push Notification features
available through the Messaging platform, please see the document Cheetah
Messaging -- Push Notification Capabilities.
Access
The Push Notification Template screen is accessible by
the following method:
Features
|
Click
hereClick
here
To create a new Push Notification Template:
Click the new item
button (plus-sign icon) above the list of existing Push
Notification Templates. The "New Push Notification
Template" pop-up window is displayed. Enter a name for
your new Push Notification Template, then click save new item. From the "Platform"
toggle, select the operating system for your app (Messaging
supports iOS and Android operating systems). The default
template for this operating system is displayed within
the JSON editor. Make any necessary
revisions to the JSON schema, and click save.
The system validates the content and syntax of the JSON
code; any errors will result in an error message. The "Push Data"
section is refreshed. This section provides a visual reference
of what the JSON form will look like on the Campaign screen.
Optionally, you can
assign fields as "Advanced Options," which means
the field will be hidden by default on the Campaign screen,
and accessible from within an "Advanced Options"
menu. To assign a field to the "Advanced Options"
menu, add the following parameter to the field's properties: Optionally, to view
an "Advanced Option" parameter within the sample
JSON form, select the parameter from the "Advanced
Options" menu. The parameter is then displayed within
the sample JSON form. To hide it again, click the "X"
icon next to the parameter name. Optionally, to hide
a field from the user on the Campaign screen, add
the following parameter to the field's properties: Optionally, to make
a field "read-only" and non-editable by the
end-user, add the following parameter to the field's properties: Optionally, to revert
back to the default schema for the selected operating
system, click revert to default
template.
|
|
Click
hereClick
here
To view or edit an existing Push Notification
Template:
When the screen is
displayed, a list of all the current Push Notification
Templates is displayed in the left-hand side of the Workspace.
Optionally, you can filter this list by typing in all
or part of a Template name in the "Search by Name"
field. Click on the Push Notification
Template that you want to view. The Workspace is refreshed
to show the details of this Push Notification Template. From the "Platform"
toggle, select the operating system (iOS or Android).
The template for this operating system is displayed within
the JSON editor. Make any necessary
revisions to the JSON schema. When finished, click
save.
|
Topic updated: December 2018
Create a New Push Notification Template
View or Edit a Push Notification Template