admin_notices

admin_notices: Configures notifications that administrators receive via a specialised room.

Venator has a concept of “admin notices” which, similar to server notices, are special messages sent by the server to a server-controlled room. In this case, the room is a read-writable notification log, which server administrators are automatically granted access to. When a notification room is created (when the first notification is sent), all current administrators will be invited to the room. Administrators will also be invited to the room when they’re promoted, and removed from the room by the server when they’re demoted.

Administrators are free to reject the invite or leave the room at any time - the room uses a custom restricted join rule that allows them to simply re-join again later, as if the room were public, but only if they’re a server admin. Other users can still join if they’re manually invited, but beware, you will not be able to remove users, as only the server has that power.

All notifications can be granularly enabled and disabled. If you’re running a public server, you may wish to enable all notifications, so that you can be made aware of potential abuse sooner. If you’re running a private server, it may still be worth enabling some of these in order to be notified in the event someone is trying to break in or something. Omitting a notification setting is the same as setting it to false (meaning all notifications are disabled by default).

All notifications enabled:

admin_notices:
  user_actions:
    on_register: true
    on_register_failure: true
    on_login: true
    on_login_failure: true
    on_deactivation: true
    on_profile_update: true
    on_password_change: true
    on_room_create: true
    on_invite_received: true
    on_invite_sent: true
    on_ban: true
    on_kick: true
  admin_actions:
    on_user_create: true
    on_user_lock: true
    on_user_suspend: true
    on_user_deactivate: true
    on_user_login: true
    on_config_reload: true
    on_room_delete: true
    on_media_delete: true
    on_media_purge: true

User actions

The following user actions are available:

• on_register: Sends a notification when a user successfully registers, including some data such as their IP address, user-agent, and initial device display name (typically the name of their client).
• on_register_failure: Sends a notification when a registration attempt is rejected with the same information as above. Rejection reasons include registration being disabled or the wrong registration token being provided.
• on_login: Sends a notification when a user logs in on a new device, with the same info as on_register.
• on_login_failure: Sends a notification when a user fails to log in, for example, due to a password mismatch, or unknown user.
• on_deactivation: Sends a notification when a user self-deactivates.
• on_profile_update: Sends a notification when a user changes their global display name, avatar, or a custom profile field, and includes the new value in the message.
• on_password_change: Sends a notification when a user’s password is changed, either self-invoked, or when done by an administrator.
• on_room_create: Sends a notification when a user creates a room, including all the information they provided for room creation (such as the name, alias, history visibility, DM status, encryption, invitee list, etc.).
• on_invite_received: Sends a notification when a local user receives an invite from a remote user. Currently unused.
• on_invite_sent: Sends a notification when a local user invites another user to a room.
• on_ban: Sends a notification when a local user is banned from a room. Includes the reason.
• on_kick: Sends a notification when a local user is kicked (not disinvited) from a room. Includes the reason.

admin_notices:
  user_actions:
    on_register: true
    on_register_failure: true
    on_login: true
    on_login_failure: true
    on_deactivation: true
    on_profile_update: true
    on_password_change: true
    on_room_create: true
    on_invite_received: true
    on_invite_sent: true
    on_ban: true
    on_kick: true

Admin actions

The following administrator actions are available:

• on_user_create: Sends a notification when an admin creates a user.
• on_user_lock: Sends a notification when an admin locks or unlocks a user.
• on_user_suspend: Sends a notification when an admin suspends or unsuspends a user.
• on_user_deactivate: Sends a notification when an admin deactivates a user.
• on_user_login: Sends a notification when an admin creates a new device/session for a user.
• on_config_reload: Sends a notification when the server configuration is hot-reloaded.
• on_room_delete: Sends a notification when a server admin deletes a room.
• on_media_delete: Sends a notification when a server admin deletes a specific media file.
• on_media_purge: Sends a notification when a server admin initiates a media repository purge, and includes details about the criteria, and how many files were removed.

admin_notices:
  admin_actions:
    on_user_create: true
    on_user_lock: true
    on_user_suspend: true
    on_user_deactivate: true
    on_config_reload: true
    on_room_delete: true
    on_media_delete: true
    on_media_purge: true