CMS status message

Basic status messages for your CMS system

Technical Name:
  • Odoo Version

License: LGPL-3

CMS status message

A "status message" is an important message that you want to show to users.

For instance: a user submit a form or does a specific action and you want to report the status of this action like "your profile has been updated" or "Your upgrade has been successful.".

This module allows to easily display this kind of messages to your users.

Messages are displayed using Twitter bootstrap alerts.

You can add several messages: they will be displayed one after another.


Python code

Set a message:

msg = _('My important message.')

By default the message type is info. The title (the label at the beginning of the message) matches the message type:

  • 'info': 'Info'
  • 'success': 'Success'
  • 'danger': 'Error'
  • 'warning': 'Warning'

You can change message parameters:

msg = _('Watch out!')
if, type_='warning', title='Oh no')

Messages will be displayed like this:



By default messages will be auto-dismissed after 8 seconds. You can turn this off by setting an ir.config_param like:

cms_status_message.autodismiss = 0

You can customize the timeout by setting the key:

cms_status_message.autodismiss_timeout = 3000  # milliseconds

You can also customize this on demand when you create the message:

msg = _('I will disappear more slowly')
options = {'autodismissTimeout': 10000}
if, dismiss_options=options)

Javascript code


var msg_tool = require('cms_status_message.tool');
var core = require('web.core');
var _t = core._t;

Inject a custom message on the fly:

msg = {
    'msg': _t('Item unpublished.'),
    'title': _t('Warning'),
    'type': 'warning'
msg_tool.render_messages(msg).then(function(html) {
    // wipe existing
    // inject new

Add a status message to the session, useful if you want to show the message only after a redirect:

var msg =  _t('Contratulations! You made it!.');
var options = {'title': _('My title'), 'dismissible': false};
msg_tool.add_message(msg, options);

Customize appereance

By default the alert box is added on top of <main /> content. If you want to customize this behavior just override or disable cms_status_message.add_status_message template.

Test your theme look and feel

Go to /cms/status-message/display-test to see how messages will look like when your theme is applied.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.




Odoo Community Association

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

To contribute to this module, please visit