Overview

Notifications can be configured to send a message into chat whenever an action is performed by InstructBot.

Each notification has two main components:

1. The message template.

2. The variables which are available.

Message Template

The message template is a piece of text which can have variables embedded within it which will be resolved at the point the message is sent. Please note the each notification has access to a different set of variables depending upon the context it's being sent within.

For example you could define the started notification as just text InstructBot has started. or include a variable within it @[AccountName] InstructBot has started.

Variables

To enter a variable surround it's name in with square brackets within the message template, for example:

@[AccountName] InstructBot has started.

In the above [AccountName] is the variable and will be replaced with the name of the account logged into InstructBot.

You can have compound variables for example User, has both [User.UserName] and [User.DisplayName] variables which will output either there user name or display name or the user.

For a complete list of variables please look at the individual notifications, as each notification will define the set of variables which it can use.