-
Notifications
You must be signed in to change notification settings - Fork 1k
Email & Push Notification Guide
This document explains what notifications exist in AVideo, when they are triggered, and where to configure them in the admin panel.
Emails will not work until you configure email sending first.
You must configure SMTP following this guide:
https://github.com/WWBN/AVideo/wiki/Setting-up-AVideo-Platform-to-send-emails
If this is not configured, no emails will be sent, even if notifications are enabled.
| Plugin | Location |
|---|---|
| Notifications | Admin Panel → Plugins → Notifications → Edit |
| CustomizeUser | Admin Panel → Plugins → CustomizeUser → Edit |
| UserNotifications | Admin Panel → Plugins → UserNotifications → Edit |
Configured in: Admin Panel → Plugins → CustomizeUser → Edit
Also quick-access via: Admin Panel → General Settings → User Settings
AVideo can require users to verify their email address after registration.
- User registers on the site.
- If
Send Verification Email Automaticallyis enabled, a verification email is sent immediately. - The email contains a button that links to
objects/userVerifyEmail.php?code=.... - When the user clicks the button, their email is marked as verified.
- The verification link has a 30-minute cooldown — it will not re-send within that window.
Users can also manually trigger re-sending the verification email from their profile page (
objects/userVerifyEmail.php?users_id=...).
| Setting | Description |
|---|---|
| Send Verification Email Automatically | Sends a verification email immediately after sign-up |
| Unverified Emails Cannot Login | Blocks login until the user verifies their email |
| Unverified Emails Cannot Comment | Blocks commenting for unverified users |
| Unverified Emails Cannot Live Stream | Blocks live streaming for unverified users |
| Only Verified Emails Can Upload | Blocks video uploading for unverified users |
| Auto-Delete Unverified Users After X Days | Automatically deletes accounts that were never verified |
| Show Email Verified Mark | Shows a checkmark icon on verified user profiles and channels |
These settings control the text of the verification email:
| Setting | Default Value |
|---|---|
| Verification Email Text Line 1 | "Just a quick note to say a big welcome..." |
| Verification Email Text Line 2 | "Cheers, %s Team." (site name is injected) |
| Verification Email Text Line 3 | "You are just one click away from starting your journey with %s!" |
| Verification Email Text Line 4 | "All you need to do is to verify your e-mail by clicking the link below" |
| Verification Button Label | "Verify" |
Configured in: Admin Panel → Plugins → CustomizeUser → Edit
Triggered when the user clicks "Forgot Password".
| Setting | Description |
|---|---|
| Recovery Email Subject | Customizable subject line for the recovery email |
| Recovery Email Text | Customizable body text shown above the recovery link |
Main plugin responsible for:
- sending emails
- showing bell notifications
- sending push notifications (OneSignal)
| Setting | Description |
|---|---|
| Email Enabled | Master switch — enables or disables all email sending |
| Bell Notification Enabled | Enables in-site bell notifications (requires UserNotifications plugin) |
| Email Logo | Logo shown in notification emails |
| Notify Verified Users Only | Send notifications only to users with verified emails |
Triggered when a video is published (direct upload or finished encoding).
| Setting | Description |
|---|---|
| Notify Video Owner | Email sent to the channel owner confirming the upload |
| Notify Subscribers | Email sent to all users subscribed to that channel |
| Notify Tag Subscribers | Email sent to users subscribed to the video's tags |
| Notify Extra Email | Additional fixed email address(es) to always notify |
| Subject | Customizable email subject |
| Message Text | Customizable email body |
| Webhook URL | HTTP POST to an external URL with the full video data |
Variables available: {user}, {videoName}, {videoLink}
Also sends a bell notification and a OneSignal web push (if enabled).
Triggered when a user posts a top-level comment.
| Setting | Description |
|---|---|
| Notify Video Owner | Email sent to the owner of the video |
| Notify Extra Email | Additional fixed email address(es) |
| Subject | Customizable email subject |
| Message Text | Customizable email body |
Variables available: {user}, {videoName}, {videoLink}
The email includes a quoted block with the comment text.
Triggered when a user replies to an existing comment.
| Setting | Description |
|---|---|
| Notify Video Owner | Notifies the video owner |
| Notify Original Commenter | Notifies the user who received the reply |
| Notify Extra Email | Additional fixed email address(es) |
| Subject | Customizable email subject |
| Message Text | Customizable email body |
Variables available: {user}, {videoName}, {videoLink}
The email includes a threaded quote showing the full reply chain.
Triggered when a user starts a public live stream.
| Setting | Description |
|---|---|
| Notify Subscribers When Someone Goes Live | Master toggle (disabled by default) |
| Subject | Customizable email subject. Supports {user}
|
| Message Text | Customizable email body. Supports {user}, {siteURL}, {siteTitle}
|
Emails are sent in batches of 100. A 5-minute cooldown prevents duplicates on reconnects. Also triggers a bell notification and OneSignal push (if enabled).
Triggered when a new user creates an account.
| Setting | Description |
|---|---|
| Notify Admin on New Sign-Up | Sends registration data to the site contact email |
| Notify When User Requests Upload Rights | Admin notification when the new user requests upload permissions |
| Notify When User Requests Livestream Rights | Admin notification when the new user requests livestream permissions |
| Sign-Up Auto-Response Message | Welcome email sent to the new user. Supports {user}, {siteURL}, {siteTitle}
|
Push notifications delivered to browsers and native apps.
| Setting | Description |
|---|---|
| OneSignal Enabled | Enable the OneSignal integration |
| Push on New Video | Send a push when a new video is published |
| Push on Live Stream | Send a push when someone goes live |
| App ID | Your OneSignal App ID |
| REST API Key | Your OneSignal REST API Key |
| Firebase Sender ID | Firebase Cloud Messaging Sender ID (for Android) |
| Debug Mode | Enables verbose logging for troubleshooting |
See the OneSignal setup guide.
The bell icon 🔔 in the top navigation shows real-time notifications to logged-in users.
Requires both Notifications and UserNotifications plugins to be enabled.
| Event | Who is notified |
|---|---|
| New video published | Channel subscribers |
| Live stream started | Channel subscribers |
Notification types: success (green), info (blue), warning (yellow), danger (red)
| Variable | Replaced with |
|---|---|
{user} |
Display name of the user who triggered the action |
{videoName} |
Title of the video |
{videoLink} |
Direct URL to the video |
{siteURL} |
Root URL of the site |
{siteTitle} |
Site title from General Settings |
The Open Source Video Platform Solution
| Service | Description | Link |
|---|---|---|
| 🎯 | Professional Support - Direct assistance from core developers | Contact |
| ☁️ | AVideo CDN - High-performance video delivery network | Pricing |
AVideo Platform © 2024 - Self-hosted video streaming platform
Made with ❤️ by WWBN and the open source community