XF 2.1 Push notifications

Welcome to the first of our "Have you seen...?" series for XenForo 2.1. We've got a lot to show you over the course of the next few weeks so you may well be hearing from us quite frequently... To ensure you're kept up to date, we strongly recommend clicking the "Watch forum" link here and enabling email notifications if you haven't done so already 🙂

But first...

The first thing that we should announce before we get started is something which we have talked about over the last year which is related to the minimum server requirements of XenForo 2.1. XenForo 2.0 currently requires a minimum of PHP 5.4, but with XenForo 2.1 we are increasing this to a minimum of PHP 5.6. Now, PHP 5.6 is still pretty old by today's standards, so you may be interested to understand why we have settled on that as our new minimum PHP version.

The answer is fairly simple, in that we are essentially trying to strike a balance between the features in PHP that we need to use, the requirements of third-party packages that we include with XenForo, and ultimately the common PHP versions that customers are using on their servers. Since XF 2.0.2 we have been keeping track of this, and these are the current results:

1539019830210.webp

To the one customer who is running PHP 7.3 Alpha I sincerely hope you are doing so in a test environment 😉
As you can see, it seems like a fairly safe bet for us to consider leaving behind PHP 5.4 and PHP 5.5 as that amounts to only 6.5% of the total customer base. One could argue that PHP 7.0 would be an ok target too as the total PHP 7.x usage is at 55.3% but leaving behind a total of 44.7% of the total customer base seems unreasonable at this point. We'd strongly recommend everyone consider upgrading to PHP 7.2 as soon as possible.

That all said, we have mentioned previously that there is one feature which will require a minimum version of PHP 7.1 to use...

Push it real good...

To view this content we will need your consent to set third party cookies.
For more detailed information, see our cookies page.
Sorry, I couldn't help myself! 🙂

That's right, we're kicking off our XF 2.1 series of HYS threads by announcing that our most popular suggestion is implemented! Let's first look at how to set it up.

1539022286792.webp

If the above browser/device requirements are frustrating then please direct your complaints to @WebKit on Twitter!

So, yes, first and foremost, you will need PHP 7.1 to enable this functionality. This enabled us to implement the functionality in a way that is compatible with as many browsers as possible, including Microsoft Edge on Android and Windows.

In addition to this, your site must be running over HTTPS with a valid SSL certificate, and you must have support for the GMP extension.

Unfortunately for reasons beyond our control (read: it's Apple's fault) the list of supported devices/browsers notably exclude Safari on macOS and any iOS-based browser. This functionality is made possible by making use of a number of APIs including the Push API and Notification API which most browsers support already.

On supported devices, the process looks something like this:

21push1.gif

You can also see that, just like alerts, we have provided a mechanism for you to be able to opt out of receiving certain push notifications. You may want to get forum alerts for everything, but only be notified by your browser for the things you find important.

The content of a push notification will be a slightly stripped down version of the default alert template. A brief note for developers; although there is code which will automatically convert HTML to a text-only version of the notification, the preferred method would be to create specific push template for each content type and action, and these will look similar to this:
HTML:
{{ phrase('x_quoted_your_post_in_thread_y', {
   'name': $user.username ?: $alert.username,
   'title': prefix('thread', $content.Thread, 'plain') . $content.Thread.title
}) }}
<push:url>{{ link('canonical:posts', $content) }}</push:url>

As you would expect with push notifications, you do not necessarily need to be viewing the forum when the notification is received, nor does the browser even need to be active, as demonstrated here:

21push2.gif

Naturally, clicking on the notification will take you straight to the content.


Alert read marking

Going straight to the content from wherever you are on your device is certainly convenient, but given that push notifications essentially represent forum alerts, it would be somewhat inconvenient to have to mark those as read too.

Therefore when you now visit content which you have previously been alerted to, the corresponding alert(s) will now be automatically marked as read.


"But I have an Apple device, will you support push notifications another way...?"

Unfortunately, this is unlikely. Although Apple devices represent a significant number of mobile users, the current approach other browser vendors are taking is standardised (meaning Apple devices could be nearly automatically supported in the future), free and seamlessly integrated with your browser. Any other approach, be that a separate app, or a third party service would, frankly, be a sub-par (and potentially expensive!) experience.

The overall solution is simple, but it is down to Apple/WebKit to take on board and implement. According to the WebKit Feature Status page, if there are any features missing you can reach out to @webkit on Twitter or contact the webkit-help mailing list. Consider doing that today to help them understand why push notifications are important for your forum 🙂


And, sadly, that brings the first HYS for XF 2.1 to an end! But don't worry - as mentioned earlier we have lots more to get through 🙂 And we may well see you for that fairly soon 😉
 
Last edited:
Chris, how easy would it be to expose the enable / disable push notifications button on the forum index?

@Chris D

hello Chris,

I believe a modal prompt is necessary, something like one signal. if it doesn't have any floating or other type of icons on the index, no one knows there is such a great feature. admin has to post lots of instructions and notification to inform users.

These days most of people are familiar with that icon and when they see such a thing, they will found that push notification feature is available on the forum. So please consider it.
 
Last edited:
Those users likely don't have an avatar, so it falls back to the site metadata logo.
I see, but technically speaking, everybody has an avatar, haven't they? Those letter avatars which are provided by default? Why not show them instead of the metadata logo?
The thing is, it looks like the official XF account has responded half of the time, it irritated me the first couple of times. Just saying.
 
Is there a way to make this option enabled by default for new members... so as soon they register, s/he is automagically registered to receive push notifications...
 
I see, but technically speaking, everybody has an avatar, don't they? Those letter avatars which are provided by default? Why not show them instead of the metadata logo?
They're not images. They're text.

Is there a way to make this option enabled by default for new members... so as soon they register, s/he is automagically registered to receive push notifications...
Nope, it requires a very explicit authorisation flow. This is a requirement of the spec. Understandable, really. Who would want to be automatically signed up to notifications for every site they sign up to?
 
They're not images. They're text.


Nope, it requires a very explicit authorisation flow. This is a requirement of the spec. Understandable, really. Who would want to be automatically signed up to notifications for every site they sign up to?

Perhaps, maybe a checkbox option while registering...
 
As much as I love seeing push coming as a stock feature I would also like to see some type of modal prompt for turning them on (assuming you guys weren't already planning for it).

1.modal prompt

A modal prompt has been added,
 
What's the onboarding like to encourage users to subscribe to push notifications?

With @Pierce's OneSignal integration I have it so that the browser notification only appears to logged in users. So only members and newly registered users get a browser notification requesting push access. Or you can set it up so that just the bell appears in the corner of the screen, and the browser permission only appears if the user clicks on the bell to follow the subscription process.

Will there be some kind of automatic modal or request for logged in users?
Or will there be a notice criteria for unsubscribed users that we can use to display a custom notice in the bottom corner of the screen?
And if so, does that apply at a user level or per browser that the user uses? ie. desktop and mobile?

Is the push API smart enough yet to distinguish between sending desktop alerts vs mobile alerts kind of like with slack?
will push notifications have per usergroup control ? so we can enable/disable push notifications per usergroup ?
I believe its an essential functionality, for all the reasons mentioned at https://xenforo.com/community/threa...anned-discouraged-specific-usergroups.154677/
If your intention, by not allowing usergroup-level control, is to have the feature not only accessible to the highest number of members, but actually used (the whole point), a modal prompt after logging in is the only viable way I've found.
Yes, modal prompt works great. I have 16K PUSH subscribers in OneSignal which is growing with 1K per month. That would never happen with a setting that needs to be searched & found for somewhere deep in account settings. Users need to be asked. Else they will never consider it. I'd have 500 PUSH subscribers without a modal prompt.
Just adding my 2 cents...

As much as I love seeing push coming as a stock feature I would also like to see some type of modal prompt for turning them on (assuming you guys weren't already planning for it). If they'll only be available by going into the user control panel and turning them on in there then I can almost guarantee that on my site that I'll end up being the only person who'd be using them.

Ideally it'd also be tied in so a reward is given for opting in so being able to assign a trophy would be nice. 🏆

At least for me it'd also be nice if opting in was a user criteria so that targeted announcements could be done. 📢
1.modal prompt
In most websites, there is an instant popup to enable push notifications as soon as we go there... just like there is a popup for accepting cookies here at xF.com... Something like it will create more visibility for this useful option...
@Chris D

hello Chris,

I believe a modal prompt is necessary, something like one signal. if it doesn't have any floating or other type of icons on the index, no one knows there is such a great feature. admin has to post lots of instructions and notification to inform users.

These days most of people are familiar with that icon and when they see such a thing, they will found that push notification feature is available on the forum. So please consider it.
This definitely needs some kind of onboard/notice/modal prompt for certain types of user.
In case you miss the suggestion thread we have now implemented an improved on-boarding approach for push notifications. It isn't a modal prompt (as such) as we feel that's a little invasive but instead a bottom fixed banner which invites the user to enable push notifications. If they wish to dismiss this, then they can do so by clicking the "X" in the top right corner. At this point, they're asked once more to enable, or otherwise "Ask later" or "Don't ask again" (for this device).

We have also added a user group permission to control who can use push notifications. So if you wanted to enable it only for certain user groups as a user group promotion/upgrade perk or similar then you can do that (it should be enabled by default for any user group/user that already has the general "View" global permission).
 
Back
Top Bottom