Server Events

Server events are triggered by the Server on certain notable occurrences, such as a new user account being created.

They allow event-listener plugins and script-event-listener procedures to react to such events, implementing custom logic as necessary.

A simple event-listener may, for example, send out an email every time a new user account is created. A more advanced example, perhaps, would be to send a request to a login analysis service every time a user logs in, such that further action could be taken upon the detection of suspicious login patterns.

This page documents the basic Server Events components, linking to the appropriate parts of the documentation for more details on the different parts of the system.

Event Listener Types

There are 2 categories of event listeners:

  • Script EventListeners
  • EventListener Plugins


To activate an event listener, it must be added to the list of active Event-listener instances. It is not enough to just create and configure the plugin or script event-listener.

Script EventListeners

Script EventListeners are scripts that run in reaction to the Server Events they are registered for.

See EventListener procedures for details.

A Script EventListener is appropriate for implementing simpler logic that may even be modified via the server configuration, without requiring a server restart.

EventListener Plugins

EventListener plugins, like script event listeners, perform custom actions in reaction to a Server Event.

They should be preferred when the required logic is too complex to be implemented in a script EventListener.

To learn more about plugins, see the Plugins section.

Types of Events

All Events that can occur in the server are sub-types of the Event interface.

Please check the Event documentation for an up-to-date list of all events.