Software

Hop PushEE

Current Version: 1.0.2
  • Demo

    For a working demo of this add-on, visit https://push.hopstudios.com/.

  • You Will Also Need

    1. You need to create the interface for how visitors subscribe to notifications—we will show you example code, but you’ll need to get folks to opt-in. The OneSignal Web Push SDK documentation is a good resource for information on setting this up, too.
    2. You will need to setup a OneSignal Web Push account to use with PushEE. Don’t worry—it’s free!
  • Installation EE 2.x

    1. Unzip the folder to a temporary location on your local hard drive.
    2. FTP the files from their local folders to the same locations in your EE install’s /system/expressionengine/third_party/ folder on the server.
    3. Navigate to Modules in your EE control panel and install the add-on. That’s it!

  • Installation EE 3.x

    1. Unzip the folder to a temporary location on your local hard drive.
    2. FTP the files from their local folders to the same locations in your EE install’s /system/user/addons/ folder on the server.
    3. Navigate to Add-ons in your EE control panel and install the add-on. That’s it!

  • Installation EE 4.x

    1. Unzip the folder to a temporary location on your local hard drive.
    2. FTP the files from their local folders to the same locations in your EE install’s /system/user/addons/ folder on the server.
    3. Navigate to Add-ons in your EE control panel and install the add-on. That’s it!

  • Usage

    1. In the OneSignal dashboard, define your audience segments. For example:
      Subscribed: Business News
      Subscribed: Entertainment News


      Note: OneSignal has a built-in segment called All that contains all your subscribers. It can be used to send notifications to all your subscribers.
    2. In EE, create your matching categories. You must set up a category for each audience segment you defined in OneSignal.
    3. Set up a custom category field whose value exactly matches the name of the matching audience segment in OneSignal. Screenshot of a custom category field
    4. Set up your EE channel(s). You can either set up an EE channel specifically for your notification entries or you can integrate PushEE functionality into existing channels.
    5. PushEE sets the URL for the notification to match the Comment URL in the channel settings. You can also override this directly in an EE template set for sending push notifications.
    6. In your channel, select one custom field that will trigger notifications. This field may use be a Select Dropdown or a Radio Button field. The field must have three values: Don’t send
      Send
      Sent
    7. Create a template for PushEE to use when sending a notification. Select it in the PushEE settings.
      Here’s a simple example of the PushEE tags used in the template. The icon, title and url will use defaults, but can also be set using specific tags. Any text output by the template will appear as the body of the notification. If the template outputs nothing, the notification won’t be sent.

      {exp:pushee:set_icon}https://site.com/images/icon.png{/exp:pushee:set_icon}
      {exp:pushee:set_title}{ title } - from { site_name }{/exp:pushee:set_title}
      {exp:pushee:set_url}{url_title_path="news/item"}{/exp:pushee:set_url}

      {if summary == ''}Click here to read the article{if:else}{summary}{/if}
      Please Note: you don’t need to use any {exp:channel:entries} tag in the template to display the PushEE field content. PushEE uses the details of the entry you are currently saving.
  • Add-On Setup

    1. Go to Modules > PushEE > Settings.
    2. Enter your OneSignal app id and API key.
    3. Select which custom field(s) in your notifications channel should trigger the notification.
    4. Select which category custom field matches to your OneSignal segments.
    5. Select which entry status(es) trigger the notification.
    6. Enter a default icon URL. This must be an absolute URL, using http:// or https://
    7. Select the template that displays the notification content.
  • Send a Notification

    tl;dr: Notifications are triggered when all conditions set in the Add-On settings are met. The conditions to be met are:

    • Custom field is set to Send.
    • The entry status matches the triggering status(es).
    • The entry is saved/published.



    1. Create a new entry in your channel.
    2. Set the custom field that determines the notification status to Send. After the notification is sent, the value of the field will change to Sent.
    3. Select the category or categories for any audience segments you want to receive the notification.
    4. Select an entry status that enables notification.
    5. Publish your entry. When all conditions are met, the notification will be sent instantly.

    Screenshot of a browser notification

    Note: You may send multiple notifications from the same entry, as long as you reset the field and status appropriately.

    Note: Your notification will be sent at the moment the entry is published. You cannot future-date your entry and have the notification send at that time; the notification will be sent immediately.

    Note: Browser notifications will not display HTML or images, only text. You can, however, vary the icon.

  • Updating

    Updating is easy:

    1. Download a new version from this website, and extract on your hard drive.
    2. Upload the new files to their appropriate locations.

  • Uninstalling

    1. Navigate to the Add-Ons/Modules tab in your EE control panel and uninstall the module.
    2. Remove the add-on directory from your EE system folder on the server.

  • Version History

    1.0.2
    UI improvement
    Small bug fixes
    1.0.1
    Change hook to trigger notifications on entry creation or entry edit
    1.0.0
    Initial Release

Have a Project for Us?

Get in Touch