notify

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).

Documentation

Index

• Variables
• type Config
  • func (nc *Config) Message() *notify.Message

Variables

var (
	Plugin = taskplugin.New("notify", "0.1", exec,
		taskplugin.WithConfig(validConfig, Config{}))
)

the notify plugin broadcasts a message over all registered notification senders

Types

type Config

type Config struct {
	Msg      string            `json:"message"`
	Flds     map[string]string `json:"fields"`
	Backends []string          `json:"backends"`
}

Config is the configuration needed to send a notification consisting of a message and extra fields implements notify.Payload

func (*Config) Message

func (nc *Config) Message() *notify.Message

Message returns the config's message