mattermost

Mattermost contrib functionality.

Function notify_mattermost

notify_mattermost(title: str, content: str | dict[str, Any], hook_url: str | None = None, channel: str | None = None, user: str | None = None, mention_user: str | None = None, icon_url: str | None = None, icon_emoji: str | None = None, **kwargs) → bool

Sends a mattermost notification and returns True on success. The communication with the mattermost API might have some delays and is therefore handled by a thread. The format of the notification depends on content. If it is a string, a simple text notification is sent. Otherwise, it should be a dictionary whose fields are formatted as key-value pairs.

Class NotifyMattermostParameter

class NotifyMattermostParameter(*args, **kwargs)

Bases: NotifyParameter

get_transport() → dict[str, Any]

Method to configure the transport that is toggled by this parameter. Should return a dictionary with "func" and "raw" (optional) fields.