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)

Mobile

kintone.mobile.showNotification(type, message)

Parameters

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

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.');
});

UI preview

The image below shows the notification message.
This may change in future product updates.

Type Desktop Mobile
ERROR

SUCCESS

INFO

Available Pages

Desktop

However, it cannot be used on the following pages:

  • Search results
  • Marketplace

Mobile

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.