Skip to end of metadata
Go to start of metadata

 Mobile Push Notification campaigns are used to send push notifications to users of your iOS and Android apps.  

  • Android:
    • Supports Firebase
    • Requires app integration with Evergage Android SDK 1.3.0+
  • iOS:
    • Supports APNS and Firebase
    • Requires app integration with Evergage iOS SDK 1.3.0+


This Article Explains

This article details how to create a mobile push notification campaign.

Sections in this Article

Android/iOS App Setup

See 'Push Notifications Guide' in Evergage SDK documentation:


Upload App's APNS/Firebase Credentials

  1. Log into the Evergage platform with administrator permissions
  2. In the Channels & Campaigns section, hover over Mobile, then click the existing Evergage-enabled app (in the image at the right it is Android Demo App)
  3. Click MOBILE PUSH SETUP 
  4. Enter/upload credentials
    1. Android:
      1. Enter/paste your Firebase Legacy Server Key as described in the Android Push Notifications Guide
      2. Click SAVE
    2. iOS:
      1. See iOS Push Notifications Guide for additional details
      2. If using APNS:
        1. Generate app's APNS certificate(s), if they don't already exist
        2. For each (Sandbox and/or Production) certificate:
          1. Save the certificate with its private key as a .p12 file
          2. Enter the password for the .p12 file, if any
          3. Click UPLOAD p12 FILE button to upload the .p12 file
      3. If using Firebase:
        1. Enter/paste your Legacy Server Key
        2. Click SAVE
        3. You’ll also need to provide your APNS credentials to Firebase, see https://firebase.google.com/docs/cloud-messaging/ios/certs

      4. If you have entered credentials for both APNS and Firebase, you must pick which one should be used when the app is next added to any push notification campaigns. Evergage will only send to one platform to prevent double-notifications.




Review Global Mobile Push Settings

  1. Log into the Evergage platform with administrator permissions
  2. In the Channels & Campaigns section, hover over Mobile, then click Mobile Push Settings
  3. Adjust Global Push Frequency as desired
    1. This limits the number of push notifications a user can receive within a timeframe, preventing spamming a user due to excessive notifications from any mobile push notification campaign, or from multiple campaigns



Creating a Mobile Push Notification Campaign in the Evergage Platform

Create a Mobile Push Notification Campaign

Mobile push notification campaigns are created at the Campaign level in the Evergage platform.

  1. Log into the Evergage platform with Campaign Editor or higher permissions
  2. In the Channels & Campaigns section, hover over Mobile, then select Mobile Push Campaigns 
  3. Click New Campaign



Campaign Settings

  1. Select SETUP  > CAMPAIGN SETTINGS
  2. Configure Campaign Settings:
    1. Required:
      1. Target Applications: Enter 1 or more applications that this campaign will send push notifications to.  Some examples of multi-app scenarios:
        1. Android and iOS versions of the same app
        2. Internal/development and production versions of the same app
        3. All of the above
      2. APNS selection: Only affects iOS apps entered in Target Applications that are configured to use APNS.  Determines if push notifications should be sent to APNS-sandbox tokens/users, and/or APNS-production tokens/users.
    2. Optional:
      1. Select a Goal and/or a Measure of Success



Send Options

  1. Select SETUP  > SEND OPTIONS
  2. Configure Send Options:
  3. Required:
    1. Trigger Type: What action will potentially cause the push notification to be sent.  Currently, actions include user-driven (segment, cart, browse, event) and catalog-driven (new, returning, expiring, low stock, price reduction).
    2. Trigger Type details: Depends on which Trigger Type is selected.
    3. Subscriber List: Evergage will only send to users on a subscribe/opt-in list.  To discuss how to manage your subscription list(s), please contact Evergage.
  4. Optional:
    1. Required Segments: One or more segments which users must be in to be eligible to receive the campaign
    2. Excluded Segments: One or more segments which disqualify users from receiving the campaign
    3. Mobile Push Frequency Limits: Campaign-specific frequency limits, in addition to the global frequency limits.



Experiences

  1. Select SETUP > EXPERIENCES
  2. Similar to other Evergage campaigns, here you can:
    1. Clone an experience
    2. Decide between A/B testing vs rule-based testing


Editor

  1. Enter the text to display in the push notification:
    1. Title: Only used by Android.  Defaults to the application name when empty.
    2. Body: Your message to the user.  This supports dynamic values.
  2. At the right, you can see a preview of the campaign as it will appear on the selected device.  You can select between various iOS and Android devices.



Using Dynamic Values

  • You can provide dynamic values, such as user name, attributes, and much more.
  • The following editor content fields are supported:
    • Title
    • Body
    • Additional Data Values (not Keys)
  • Insert dynamic content queries by selecting a supported editor content field, clicking the Dynamic+ dropdown, and selecting an option.
  • Supported queries include both Dynamic Message Content (DMC) and Advanced Dynamic Message Content (ADMC).  If the value cannot be fulfilled, then the experience (and potentially campaign) cannot be triggered.  You can use the #field syntax to provide a fallback value.  See the A/DMC links for more info.




Advanced Settings

Click SHOW ADVANCED SETTINGS to expand this area and HIDE ADVANCED SETTINGS to collapse it.  Here you can define advanced parameters:

  • Both iOS and Android:
    • Time To Live: How long Firebase/APNS should attempt trying to deliver the notification to each device, since it could be offline/unreachable.  Shared across all apps/devices in the campaign.  The default is around one month.  The value '0' is special and means 'now or never', i.e. attempt to deliver it at trigger/send time, but don't queue it for later delivery if the device is unreachable.
    • Sound: The app sound filename/identifier to use.  Unspecified/empty means no sound.  The value of 'default' will use the OS's default/system sound.  Each app can define its own sound.
    • Additional Data: A set of key/value pairs, containing additional info of your choice.  Dynamic values are supported (see above).  Typically used to convey user/product information.  Each app can define its own data.
  • Android-specific:
    • Click Action: Which Activity should display (and consume any Additional Data) when the user opens the notification.
    • Icon: The app icon filename/identifier to use.
    • LED Color: The color to flash with the device's LEDs.
    • Collapse Key, Channel ID, Tag, Restricted package name: Refer to Firebase programming guide.
  • iOS-specific:
    • Badge: What number, if any, to set the app icon's badge to.  The default (empty) has no affect on the badge.  The value '0' will clear/remove the badge.
    • Category, Thread ID: Refer to APNS programming guide.