The notifiers are plugins for Runnerty used for notify events occurred in the processes or chains.
There are a bunch of notifiers for different channels. You can have a look at the official list here.
In the config.json file of the project we are going to write the configuration of the different notifiers that are going to be used in the processes.
This is an example of the configuration of two notifier:
@runnerty/notifier-mail. Each notifier has it's owns properties, some of them are mandatory, you can have a look at each notifier documentation to know how to use them.
The destination of a notifier is to use it in our plan's processes to communicate notifications. We could say that using a notifier has two parts:
The configuration properties are set in the config.json. They are the identifiers fields of the notifier. For example, this is the configuration properties for the @runnerty/executor-telegram:
id is the name given for the executor configuration. Note that we could have all the differents configurations that we want for the same executor. The
type is the name of the executor. The
chat_id and configuration properties needed for the executor to work properly.
In the processes are set the variable properties (params) of the notifier. This is an example of the usage of the @runnerty/executor-telegram in a process
Runnerty matchs the
id property from the plan with the config.json one to identify the notifier to run. the
message field is the variable property that may change in every process.
It is important to notice that it is possible to overwrite some configuration properties IN THE processes. For example: if we want to change the token and chat_id of the notification depending of the event:
When the process ends with fail it will overwrite the
chat_id properties of the config.json and it will send the message to a different chat.