# README
notify Plugin
This plugin sends a message over any of the notification channels defined in µTask's configuration.
Configuration
| Fields | Description |
|---|---|
message | the main payload of the notification |
fields | a collection of extra fields to annotate the message |
backends | a collection of the backends over which the message will be dispatched (values accepted: named backends as configured in utask-cfg) |
Example
An action of type notify requires the following kind of configuration:
action:
type: notify
configuration:
# the payload of your notification
message: Hello World!
# a list of extra fields as map of string, to contextualize your message
fields:
randomfield: urgent
language: english
# a list of destination backends as defined in 'utask-cfg' (will be sent to ALL backends if left empty or null)
backends: [tat-internal, slack-customers]
Requirements
Configuration for at least one notification backend should be provided in the config item named utask-cfg (see config/README.md).
# Variables
the notify plugin broadcasts a message over all registered notification senders.