Skip to main content

​
Overview

Notices allow you to communicate important information to your users, such as updates, announcements, or outage information. Notices are managed through the Overlayed Dashboard and automatically fetched by your overlay application.

​
Managing Notices

To create and update existing notices, navigate to the Overlayed Dashboard.

​
Listening for Notices

Notices are automatically fetched:
  • When your overlay initializes
  • Every 5 minutes
  • When a game becomes ready
Notices will already be appropriately filtered. 
const overlay = overlayed({
	// ...
});

overlay.notices.on("noticesUpdated", ({ notices }) => {
	// ...
});
Notices that are tied to a specific game will automatically be returned based on the games that are currently launched.

​
Getting Current Notices

Get the current filtered list of notices. 
const activeNotices = overlay.notices.getNotices();

​
Dismissing Notices

Notices can be dismissed by calling the dismissNotice method. 
overlay.notices.dismissNotice(noticeId);
Dismissed notices are stored locally in a notices.json file in your app directory. A maximum of 100 dismissed notices are stored—once this limit is reached, the oldest dismissed notice is removed.