Important

BurntToast is no longer maintained.

This repository has been archived. I no longer have the time to give the project the attention it needs.

The code and existing releases remain available, but there will be no further updates, bug fixes, or support from me. You’re welcome to fork the project and continue development under its existing license.

Thank you to everyone who has used BurntToast, contributed improvements, and helped others along the way. I’m proud of what this project has made possible, and grateful to have been part of it.

BurntToast

PowerShell Module for displaying Toast Notifications on Windows 10 and Windows Server 2019 and above.

Install

PowerShell Gallery Install

Install-Module -Name BurntToast

See the PowerShell Gallery for the complete details and instructions.

Chocolatey

choco install burnttoast-psmodule

See the Chocolatey community package for more details. Thanks Bill Curran for maintaining the package.

Releases

v1.1.0

Features and Improvements

• Add support for Important Notifications using the Urgent switch.

• Add support for setting button colors.

• Center align notification body text when using the IncomingCall scenario.

v1.0.1

Bug Fixes

• OnActivated events are "sticky"

  • See #256 by Windos

v1.0.0

Breaking Changes

• Custom Audio Path Removed: Support for custom audio file sources has been eliminated.

• AppId Customization Removed: The ability to specify a custom AppId has been removed.

• Shoulder Tap Notifications Removed: Support for "shoulder tap" toast types is no longer available.

Features and Improvements

• Shortcut Support: Introduced capability to create Windows shortcuts with proper AppUserModelID—enables full toast branding when launching PowerShell.

• Event Data Improvements: Event data handling and options improved for notification actions.

• Enable "Activation" events on all supported versions of PowerShell, including Windows PowerShell.

• Enable "Dismissed" and "Failed" events on PowerShell 7.1+.

• Improve support for attribution text.

Libraries

• Microsoft.Windows.SDK.NET.Ref library bumped to 10.0.22621.28.

• Microsoft.Toolkit.Uwp.Notifications library bumped to 7.1.3.

See previous releases in the Full Change Log

We're Looking for Maintainers!

To ensure the long-term health of this project and prevent maintainer burnout, I'm looking for some additional helping hands. All contributions are of great value, from code and documentation to issue triage and testing.

If you are interested in helping guide the future of this project, please let me know by filling out our Maintainer Request Form. Look forward to hearing from you!

Contributors

• Windos
• jeremytbrun
• KelvinTegelaar
• steviecoaster
• glennsarti
• UniverseCitiz3n
• cedarbaum

License

• see LICENSE file

Image Credit

The default image for BurntToast Notifications is a photo taken by Craig Sunter

Contact

• Bluesky: @toastit.dev
• Mastodon: @windos@mastodon.nz
• Twitter: @WindosNZ
• Blog: ToastIT.dev