Notification plugins: Sending notifications

Notifications are sent with the help of a notification plugin to one or more destinations.

A notification plugin is a class that inherits from argus.notificationprofile.media.base.NotificationMedium. It has a send(event, destinations, **kwargs) static method that does the actual sending.

A destination is a user-specific and plugin-specific instance of the model DestinationConfig. In the DestinationConfig there’s a field settings that has the necessary configuration for where to send the notification for that type of plugin, like an email address, a phone number or a webhook.

A specific type of destination might also need extra settings in the Django settings file, this is documented for each plugin.

Existing notification plugins

Notification plugins maintained by Argus developers, vendored

Notification plugins maintained by Argus developers, optional

Microsoft Teams

Class: argus_notification_msteams.MSTeamsNotification
Source: https://github.com/Uninett/argus_notification_msteams
PyPI: argus-notification-msteams

Other notification plugins

None known to us at this time.

Note

Open an issue on Github to have your integration added to this list. It needs to be publicly accessible (and preferably available on PyPI) so we can check the code. We will link up both the source code repo (or homepage otherwise) and the PyPI-entry.

Configuring which notification plugins to use

In the Site-specific settings file the setting MEDIA_PLUGINS is a list of enabled plugins.

The default is:

MEDIA_PLUGINS = [
    "argus.notificationprofile.media.email.EmailNotification",
]

Writing your own notification plugins