Forge Toaster example app

This is an example Atlassian Forge app demonstrating how to display a transient "flag" message (also known as a "Toast" on some platforms) to a specific user on your Jira site. This implementation will show messages on the view issue and/or dashboard views.

Getting Started

• Clone this repository.

• Register a copy of the app to your Atlassian account:

forge register

• Install top-level dependencies:

npm install

• Deploy your app:

forge deploy

• Install your app into an Atlassian site:

forge install

Sending messages

• In Jira Cloud, browse to Settings > Apps > Send User Message.
• Pick an account to notify, select a message style, and input a message title, and description.
• When the user next browses to an issue or dashboard on your site, a flag will be displayed with your message.
• The message will be displayed each time the user browses to an issue or dashboard until they press the Acknowledge action.
• You can test the app by sending yourself a message and browsing to an issue or dashboard.

Architecture

Forge Toaster uses three modules:

• an adminPage used to create new messages; and
• an issueViewBackgroundScript and a dasboardBackgroundScript that checks for pending messages and displays them to the user

The toast messages are stored as custom entities.

Requirements

• Requires Node v20+ (tested on v20.18.1)

License

Copyright (c) 2025 Atlassian and others. Apache 2.0 licensed, see LICENSE file.