overwolf.notifications API

Use this API to send toast notifications from your OW app.

Toast are interactive OS notifications that lets you create flexible "reminders" with text, images, and buttons/inputs. Toast notifications are a combination of some data properties like header, visual (hero image, inline image, app logo) and the toast content.

Note that currently using toast on an unpacked app does NOT work.

Methods Reference

• overwolf.notifications.showToastNotification()

Events Reference

• overwolf.notifications.onToastInteraction

Types Reference

• ToastNotificationParams Object
• ShowToastNotificationResult Object
• LogoOverride Object
• ToastNotificationButton Object
• ToastNotificationEvent Object
• overwolf.notifications.enums.AppLogoCrop enum
• overwolf.notifications.enums.ToastEventType enum
• overwolf.notifications.enums.ToastEventError enum

showToastNotification(args, callback)

Version added: 0.176

Show Windows toast notification.

Parameter	Type	Description
args	ToastNotificationParams object	Toast notification params
callback	(Result: ShowToastNotificationResult) => void	Returns with the result

Usage example

overwolf.notifications.showToastNotification({
  header: "Header",
  texts: ["text1", "text2"],
  buttons: [
    { id: "button_1", text: "button 1" },
    { id: "button_2", text: "button 2" }
  ]
}, console.log);

The above line of code triggers this notification:

notification-example

Protocol activation example

// Register "protocol_override_domains": { "myapp": "myapp://" } in your manifest

// At app startup, listen for URI activations:
overwolf.extensions.onAppLaunchTriggered.addListener(({ origin, parameter }) => {
  if (origin === "urlscheme") {
    const url = new URL(parameter);
    if (url.pathname === "//open-replay") openReplayView(url.searchParams.get("id"));
  }
});

// Show a toast that routes through onAppLaunchTriggered when clicked:
overwolf.notifications.showToastNotification({
  texts: ["Match saved!", "Click to review your last game"],
  activationType: "protocol",
  launch: "myapp://open-replay?id=abc123",
  buttons: [{
    id: "review",
    text: "Review now",
    activationType: "protocol",
    launch: "myapp://open-replay?id=abc123&autoplay=true",
  }],
}, console.log);

ToastNotificationParams Object

Parameter	Type	Description
header	string	See notes
texts	string[]	Mandatory. See notes.
logoOverride	LogoOverride object	See notes.
heroImage	string	See notes.
inlineImage	string	See notes
attribution	string	See notes
buttons	ToastNotificationButton[]	See notes.
activationType	string	See notes
launch	string	See notes

header notes

You can provide a headline to the notificaiton.

texts notes

Texts parameter must exist and include 1-3 texts (lines).

logoOverride notes

By default, your toast will display your app's logo. However, you can override this logo with your own image.

heroImage notes

Toasts can display a hero image, which is displayed prominently within the toast banner and while inside Action Center. Image dimensions must be 364x180 pixels.

inlineImage notes

You can provide a full-width inline-image that appears when you expand the toast.

attribution notes

If you need to reference the source of your content, you can use attribution text. This text is always displayed at the bottom of your notification, along with your app's identity or the notification's timestamp.

buttons notes

Buttons make your toast interactive, letting the user take quick actions on your toast notification without interrupting their current workflow. Buttons appear in the expanded portion of your notification.

activationType notes

Controls what happens when the user clicks the toast body.

• foreground (default) — fires the in-process onToastInteraction event.
• protocol — Windows invokes the URI set in launch via the registered URL scheme. Routes to overwolf.extensions.onAppLaunchTriggered even if the app is not running.

launch notes

The URI to invoke when activationType is "protocol". Must match a scheme registered in your app manifest under protocol_override_domains.

ToastNotificationButton Object

Parameter	Type	Description
id	string
text	string
activationType	string	"protocol" — invokes the URI in launch via onAppLaunchTriggered. Omit for default onToastInteraction behavior.
launch	string	URI invoked when activationType is "protocol".

LogoOverride Object

Note: Must be 364x180.

Parameter	Type	Description
url	string
cropType	AppLogoCrop enum

ShowToastNotificationResult Object

Parameter	Type	Description
success	boolean	inherited from the "Result" Object
error	string	inherited from the "Result" Object
id	string

AppLogoCrop enum

Version added: 0.176

Specify the desired cropping of the image.

Option	Value	Description
Default	"Default"	Cropping uses the default behavior of the renderer.
None	"None"	Image is not cropped.
Circle	"Circle"	Image is cropped to a circle shape.

onToastInteraction

Version added: 0.176

Fired when a user tapped on the body of a toast notification or performed an action inside a toast notification, with the following structure: ToastNotificationEvent Object.

ToastNotificationEvent Object

Parameter	Type	Description
id	string
eventType	ToastEventType enum
buttonID	string
error	string
errorCode	ToastEventError enum

ToastEventType enum

Version added: 0.176

Describes the toast event type.

Option	Value	Description
Dismiss	"dismiss"
ButtonClick	"buttonClick"
Error	"error"

ToastEventError enum

Version added: 0.176

Describes the toast event error.

Option	Value	Description
Unknown	"unknown"
NotificationsDisabled	"notificationsDisabled "
Error	"error"