Skip to content

Notifications Plugin

Daniel Neto edited this page Aug 2, 2023 · 10 revisions

Notification Setup Guide

To enable notifications on your platform, you will need to acquire the Notification plugin from here.

Notification by Email

Ensure that your email is properly configured. If you're unsure about how to do this, follow the instructions provided in this guide.

Browser and Mobile App Notifications

Utilizing Web Push and Native App Platforms

OneSignal Integration

We have selected OneSignal for its excellent features, offering Unlimited Web & Mobile Push Notifications and accommodating 30K web subscribers for free.

To enable the OneSignal service with the Notification plugin, you need to provide us with the following information:

  • oneSignalEnabled:

    • Check the option above to enable it.
  • oneSignalAPPID:

  • oneSignalRESTAPIKEY:

  • oneSignalFIREBASE_SENDER_ID:

After configuring the above, all further setup must be performed on the OneSignal site.

For iOS notifications, we recommend following this tutorial. However, please note that "Option A: Try out our Automatic Provisioning Tool" might not work for everyone. In such cases, you can opt for Option B: Create Certificate Request Manually.

Important: Uploading the OneSignal SDK

If you select full HTTPS, do not forget to upload the OneSignal SDK files to the top-level root of your site directory. These files can be downloaded from the OneSignal website.

Webhooks

We provide a webhook to notify you of new videos, and it will send the following fields:

Column Value
id Primary key of the video
title Video Title
clean_title Clean Video Title (URL)
description Video Description
status Video Status [a, i, u]
created Video Date of creation
users_id User Id
categories_id Category Id
filename Video File name used to host
duration Video duration
type [video, audio, embed]
imagesJson A JSON with the images for the video
url The video Streamer URL
urlEmbed The Video Streamer URL for embed

By following these instructions and setting up the necessary configurations, you can enable effective notifications on your platform and keep your users informed and engaged.

Clone this wiki locally