API Docs

Display Notification Message

Display Notification - kintone.showNotification(type, message)

Displays a notification message at the top of the page.
Color-coded messages can be displayed according to the message type.

Function

Desktop

kintone.showNotification(type, message)

Parameters

Parameter Type Required Description
type String Yes The type of NotificationUI.
  • ERROR: A red NotificationUI representing an error.
  • SUCCESS: A green NotificationUI representing success.
  • INFO: A blue NotificationUI representing information.
message String Yes The text of the message to display in the A NotificationUI.

Returns

A Promise object.
The following values can be retrieved when the Promise object is fulfilled.

Sample Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

// Display error message
kintone.showNotification('ERROR', 'Failed to save data.');

// Display success message
kintone.showNotification('SUCCESS', 'Data has been saved successfully.');

// Display info message
kintone.showNotification('INFO', 'Processing started.');

// Usage example with asynchronous processing
kintone.showNotification('SUCCESS', 'Processing completed.').then(() => {
  console.log('Notification has been displayed.');
});

Available Pages

Desktop

However, it cannot be used on the following pages:

  • Search results
  • Marketplace
  • Plug-in settings page

Notes

  • Messages do not automatically disappear after being displayed at the top of the page.
  • Only one message can be displayed at a time, including those from Kintone itself. Only the most recently called message will be displayed.