Edit on GitHub

Use message priority

Messages can be sent with a priority level to help users identify the importance of the message. For more information about message priority, see formatting text.

Priority options 

When sending a message, you can use any of the following to format how you want the posted message to look.

priority: A required plain-text summary of the message. This is used in notifications, and in clients that don’t support formatted text (e.g. IRC).

requested_ack: If set to true, the message will be marked as requiring an acknowledgment from the users by displaying a checkmark icon next to the message. Keep in mind that this requires the message priority to be set to Important or Urgent.

persistent_notifications: Only for Urgent messages. If set to true recipients will receive a persistent notification every five minutes until they acknowledge the message.

Example of post priority 

{
    "priority": {
        "priority": "urgent",
    }
}

And this is how it renders on Mattermost:

Urgent message priority

Example of post priority with requested acknowledgment 

{
    "priority": {
        "priority": "important",
        "requested_ack": true
    }
}

And this is how it renders on Mattermost:

Important message priority

Did you find what you were looking for?

Thank you! We appreciate your feedback.
×

Tell us more

Your feedback helps us improve the Mattermost developer documentation.

Have a feature request? Share it here.

Having issues? Join our Community server.