Notification Mixin

NotificationMixin¶

The NotificationMixin class provides a plugin with the ability to send notifications to users when certain events occur in the system.

Any notification which is generated by the InvenTree core system can be sent to users via a custom plugin which implements this mixin class.

send_notification¶

The send_notification method is used to send a notification to users:

Send notification to the specified target users.

Parameters:

Name	Type	Description	Default
`target`	`Model`	The target model instance to which the notification relates.	required
`category`	`str`	The category of the notification.	required
`users`	`list`	List of users to send the notification to.	required
`context`	`dict`	Context data for the notification.	required

Returns:

Name	Type	Description
`bool`	`bool`	True if the notification was sent successfully, False otherwise.

Source code in src/backend/InvenTree/plugin/base/integration/NotificationMixin.py

def send_notification(
    self, target: Model, category: str, users: list, context: dict
) -> bool:
    """Send notification to the specified target users.

    Arguments:
        target (Model): The target model instance to which the notification relates.
        category (str): The category of the notification.
        users (list): List of users to send the notification to.
        context (dict): Context data for the notification.

    Returns:
        bool: True if the notification was sent successfully, False otherwise.
    """
    # The default implementation does nothing
    return False

filter_targets¶

If desired, the plugin can implement the filter_targets method to filter the list of users who will receive the notification. This allows for more granular control over which users are notified based on specific criteria.

Filter notification targets based on the plugin's logic.

Source code in src/backend/InvenTree/plugin/base/integration/NotificationMixin.py

def filter_targets(self, targets: list[User]) -> list[User]:
    """Filter notification targets based on the plugin's logic."""
    # Default implementation returns all targets
    return targets

Built-in Notifications¶

The following built-in notifications plugins are available: