Create notification - Workflow Toolbox

The Create notification toolbox item will add a system notification for one or more users/teams. Users can choose how to receive the notification by changing their notification preferences. You can find the available notification types in Admin > Channels > Notification. You can find out more about creating new notification types here -  Configuring Notifications‍.

Common Uses

This toolbox item is commonly used for notifying team members when a particular task is completed, or a phase is changed. This could be used for a wide variety of events, but it is recommended not to overuse this function to ensure that notifications remain focused.

Pre-requisites

Users/Teams variable - you will need to have captured the ID for the user/team to which the notification should be sent.

OR

Recipient roles on work item - if you are relating this notification to a work item, you can select recipient roles. This option can be used in addition to or instead of the users/teams option.

Step - you will need to have a step on your canvas into which to drag it.

Configuring Create notification

  1. Click on the toolbox tab of your workflow canvas
  2. Select the Create notification option and drag it onto the step in which you wish to place it
  3. Click on the Create notification item you have dragged onto the canvas to add the configuration
  4. Enter the configuration for the toolbox item
Action Name Give the action a name e.g. 'Phase Change Notification'
Notification Type Choose your desired notification type from the drop-down menu.  
Notification types are configured in the admin area of the application - you can read about how to do this in Configuring Notifications.‍ 
Notification Title Give the notification a title - this will show at the very top of the notification itself and can also contain variables (for example work item ID)  
Notification Message

Provide a message for the notification - this will show in the body of the notification and can also contain variables (for example work item ID)

Relate notification to work item If you wish to relate the notification to a work item, select the relevant variable and this will add a clickable link to the bottom of the notification.  
Send to holders of these roles on the work item This option is only visible if you have related the notification to a work item. This allows you to send this notification to one or more roles on the work item. This option can be used in addition to or instead of the users/teams option.
Send to users/teams contained in this variable Specify the variable holding the ID(s) of the recipients for this notification. This option can be used in addition to or instead of the work item roles option.