Creating and Using In-Game Messages

In-Game Messages let you connect to your players through UI-based messages in your game.  For example, you may want to notify them of an upcoming event or you might want to send them a thank you message (including a gift) for being a great player.

Message Type and Additional Message Fields Setup

To add additional flexibility, you have the ability to create custom message types specific to your organization (e.g. 'event reminder' or 'gift').  Each message type can include custom additional fields which will then be available in the message editor when the message type is selected.  The message type templates are created using JSON-based template definitions. Visit the JSON Templating article to learn more about how you and your team should structure your custom JSON-defined templates.

To edit custom message types and additional message fields, navigate to UserWise settings and click on Messages in the menu bar.  The default message type will automatically be selected.  You can add additional message types using the custom message types field and navigate between message types using the message type dropdown.

In order to modify a message type's additional message fields, you should have some knowledge of how JSON works and what the SDK will expect to receive on initialization.  You'll create a JSON hash to define the fields which are needed.  Everything can be nested.  See the JSON Templating article to learn more.

Note that if any messages have already been created with a particular message type, modifying the additional fields template will NOT automatically update the messages.  In order to avoid major mistakes that could impact your users, you will have to edit each message manually and load the new configuration.  Affected messages will include a warning letting you know that the additional fields configuration has changed.

Create a Message

Enter the campaign to which you would like to add a message.  Navigate to the content section and click the "+" button beside the "Messages" header.  The default message type is auto-selected; you can select the message type you just created above to update the additional fields available.  Changes you make will autosave and if the campaign is live the message data will be available in the SDK for your users.