Web Push notifications using OneSignal
 

Description:

OneSignal has an API that allows us to send unlimited web and push notifications for FREE. When I came to know about it, I spent several days and months searching for compatible plugins for vB4. Finally decided to learn and create my own based on pierce's similar mod for Xenforo.

Push notifications is a great way to keep your members engaged. It keeps driving them back to your site. This mod works great on mobile browsers as well.

This is the lite version which allows you to send web push notifications to your users whenever:

1. someone replies on their subscribed threads
2. sends them a PM
3. likes one of their posts (dbtech thanks)

Installation:

1. Register an account at OneSignal.com

   • Click on Add a new app to register your forum there
   • Select Web Push as the platform
     https://vborg.vbsupport.ru/external/2018/07/4.png
   • Configure Web Push by selecting Typical Site and enter you forum details
     https://vborg.vbsupport.ru/external/2018/07/5.png
   • Add at least one prompt and complete the remaining setup there. Leave most of the options as default. Only change where necessary.
   • After you click Save, you will get a few files to download.
     https://vborg.vbsupport.ru/external/2018/07/6.png
   • Download those files, extract them and upload them to your forum's root directory.
   • There is another section on the same page asking you to add code to your site. DO NOT add that code yet. It is automatically done when you install this product.

2. Download attached zip file. Upload the file functions_OneSignal.php under /includes directory
3. Install the product using the xml file
4. Go back to onesignal.com, under settings, click on Keys & IDs.
   https://vborg.vbsupport.ru/external/2018/07/7.png
5. Copy these keys and paste them in the settings in admincp.
   https://vborg.vbsupport.ru/external/2018/07/8.png

Disclaimer:
I am not associated with onesignal in any way. This is just something that I found useful for my forum and wanted to share with everyone else.

If I get enough support then I plan to add notifications for moderators' actions and for quotes and tags as well.


Download latest version: 1.3.5
If upgrading from previous version, replace the functions file as well.

Change log:
1.3.5 - Typo fixed
1.3.0 - Separated multiple consecutive notifications for different threads
1.2.0 - Added privacy for replies in private sections and
Subscribe button at the end of posts
1.1.0 - Fixed issue with sub-forum
1.0.1 - Fixed Table Prefix bug
1.0.0 - Initial Release

Screenshots:


Demo on vB4Mobile.com and IslamicBoard.com

This looks extremely interesting

Glad you liked it. Screenshots are added in the above post.

something that I noticed is that the server load spikes when this is active - testing more

How big is your forum and how many users are active simultaneously?

looking forward to testing this, not sure when i will be able to, but the other mod like this i tried had some fatal conflicts somewhere with other mods or whatever i was using.

i can't say with certainty that my load spike is your mod. I'll watch it though

Good afternoon.
I installed the mod, did everything according to the instructions, notifications come only from the themes of one forum, from other forums it comes only to e-mail. What could be the problem? Thank you!

sends notifications only from the topic, in English. Of those in the Russian language does not send. How to solve a problem? Thank you!

Even if the topic name in English, and the text of the response in Russian, the notification is not sent.

I am not sure why it doesn't work for Russian. Can you check your OneSignal control panel for message logs and see if there is any error listed there?

I have tested this with another language and it worked fine for me without any issues.

thanks for the answer.
if I send test messages from the OneSign panel, there are no errors. When I create a topic on the forum, the name in English, I write in it in English, there are no problems, push message comes. I think that the error with the processing of php mod ... or the encoding does not understand. I do not see any errors in the logs. And I tried to translate phrases in a php file, for example, "replied to", immediately ceases to send push messages.

and perhaps when sending push to convert the encoding cp1251 to utf-8? I see that the problem is this. Thank you.

And can I make it so that a notification without nicknames, topic names and messages is sent? The usual notification is a "new answer", or "a new personal message". And click on the link to send a link to a topic or personal message.
That would be the right decision! Moreover, I have a very small notice on the 27 "screen, and it's easier for me to click and read on the site." It's also more convenient for me to follow the link on a mobile phone.

Hi, I've followed your instructions exactly, but notifications to subscribe are not showing.
I'm just running a test board at the moment to see the capabilities of the software and it is located atIn the settings on OneSignal it does not allow me to enter that location, only - could this be the reason it isn't showing?
Thanks.


Update:
Sorry I was being impatient. It's showing now, but as my connection is private it's blocking notifications. I'll see how it runs for other people though, thanks for providing this plugin.

Replace the file includes/functions_OneSignal.php with the attached file. You can even open that file in a text editor and modify the messages as you like.

:up: Yes! working!!!
PM removed from the code?
I change the text in the script if the English language works, if the Russian text does not send messages. I do not understand the problem.

and the transition from push notification to the wrong place where the new answer, but simply to the home page.

No, PM is not removed. It is there at line # 51.

<a href="https://www.carhelp.info/showthread.php?p=1544887&utm_source=onesignal&utm_ medium=push&utm_campaign=onesignal" target="_blank">https://www.carhelp.info/showthread....aign=onesignal</a> Here such link comes in push, I think the end superfluous?

ok!


and this is a link where you had to switch by click to push.
https://www.carhelp.info/forums/show...87#post1544887

If you are using this you may want to take a look here - https://xenforo.com/community/thread...e-this.153212/

IMO there are GDPR implications.

in the delivery report in onesignal if you look there writes here such
Filters {"key":"uid","field":"tag","value":"10234362","rel ation":"="}
all links in notifications have the wrong view. How to fix it? Thank you!

your mobile phone transmits a lot more personal data.

in the settings of the service configured not to open in a new tab, but to switch to the tab if it is open in the browser. still open a new tab. I do not understand why.

Check your forum url settings in Admincp -> Settings -> Options -> Site Name / URL / Contact Details
https://www.carhelp.info/forums/admi...ogroup=address

Have you entered the correct url for your forum there?

This is something which cannot be controlled from this add-on. It can only be configured from OneSignal.

The end part is for Google Analytics. If you use analytics, then you can easily check how many users clicked on the notification and visited your forum.

Yes, it's all true. links to e-mail come correct.



probably because of the incorrect links, there on the service I set everything correctly.

I do not have such settings anywhere.
but the question is why the link to push notification comes here is this:
but here is the email:
a link to the email opens a topic or a PM, and the link from the push notification opens first 404 and then goes to the main page of the forum.

???

I have modified the attached file once again for your forum. Try it and let me know if it works.

The sub-folder link for your forum is hard-coded in the links.

Thank you! Now goes into the topic and to the PM!
when you go to the topic, opens the page you want, but you need to scroll the page to the post. If there are ideas how to correct I will be very grateful!

:up::up::up:

Hello.
Recently, I install this fantastic mod, but I don't sure if work correct.
Appears the icon, push in the icon notification and appears: Subscribe to notifications.
Ok, but if push again, appears the same (not for disable notifications, for example). This work like indicate?

Thanks and regards!

Notification not works in 3.8x i already reply there

Since I installed in vb 4.2.5 I received notifications (by forum) for new threads and pm, but onesignal not indicate, not push notification with this mod.
I don't know what happens, because, I don't have any error...

Regards.

Hi, my problem was solved.
I upload the files that we download of onesignal in my forum directory (my site its: www.mydomain.com/forum) and upload the files of onesignal in /forum folder.
Error, I upload to root folder (public_html) and now, yes, work fine.

Regards.

Thanks for the feedback. I will try add it in the next update.


When you click on the bell again, it shows the unsubscribe button, like this:


Thank you for the confirmation.

Yes, after upload the files of onesign to root folder (not to the folder of forum) now, appears like you indicate, if click in the bell again, now, shows the unsusbscribe button, now, work fine :)
But after this change, I have replys in suscribe threads but not have notifications in this bell.
Thanks and regards!

Hello.
I continue with the tests, like indicate in last reply, yes, now when I click on the bell again, it shows the unsubscribe button like you image, appears work fine.
But when I have new reply on one thread or quoted, I don't received any notification in this bell.
I received notification in browser but I think this is because, also, I have installed Advanced User Tagging

But the bull not indicate any notification.

Thanks and regards.

If you get notification as shown in screenshot in post #2
https://vbulletin.org/forum/showpost...89&postcount=2 then it is working fine.
The notifications are not inside the bell. It is actually browser notification. On desktop as well as on smartphone.