Display Message
Audience:
Low-code EngineersSkill Prerequisites:
HTML,Actions
Shows a message to the user and ends execution. It's usually the last action of a submit button, where it replaces the form with a confirmation. The message can contain HTML and tokens.
It's available in Forms and User Guides.
Typical Use Cases
- Show a confirmation after a form is submitted, for example
Thank you, [Name]! Your request [RequestId] was received. - Show the submitted values back to the user
- Tell the user what they can do next, with buttons to continue, such as downloading a file or going to another page
- Show a message instead of the form when the form shouldn't be filled in, from the form's
On Initevent - Show a short message in a User Guide step when a step button is clicked
Don't use it to
- Show an error. Use Display Error Message, which keeps the form on screen and uses error styling.
- Show a short notification that disappears on its own. Use Display Toast Message And Continue Execution or Display Toast Message And Stop Execution.
- Show a message and keep running actions. Display Message always ends execution.
- Debug. Use Log Error instead.
Related Actions
| Action Name | Description |
|---|---|
| Display Error Message | Shows an error message and ends execution. The form stays on screen. |
| Display Toast Message And Continue Execution | Shows a small popup that hides on its own, then runs the next actions. |
| Display Toast Message And Stop Execution | Shows a small popup that hides on its own and ends execution. |
| Stop Execution | Ends execution without showing anything. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Message | The content to show. It's a rich text editor, so it can contain HTML. Use the Append Field dropdown to add a field's name and token, or Append All Fields to add all fields. Fields are added at the end of the existing content. | Yes | empty string | No |
| Action Buttons | Forms only. One or more buttons from the form to show under the message. Clicking one runs that button's own actions, for example a redirect or a file download. Hidden buttons, based on their visibility condition, aren't shown. Avoid picking the button that runs this action, so buttons don't reference each other recursively. | No | [] | No |
Where the message appears
| Where it runs | What the user sees |
|---|---|
| Form, button actions | The form fields slide up and hide. The message is shown in its place, in a centered info box, and the page scrolls to it. The fields aren't shown again until the page reloads. |
Form, On Validation Failed | The form stays on screen and keeps its values. The message is shown in an info box under the form. |
Form, On Init | The form isn't shown. The message is shown instead, in an info box. |
| User Guide, step button | The step stays open. The message is added to the step's popup, in an info box, replacing any earlier message. The button can be clicked again. |
Module differences
| Module | Parameters | Behavior |
|---|---|---|
| Forms | Message, Action Buttons | Hides the form and shows the message in its place, except in On Validation Failed. |
| User Guides | Message | Adds the message to the step's popup. |
Display Message isn't available in Listings, API endpoints or workflows.
Considerations
- Final action. No actions after Display Message run. Put it last, after the actions that save data or send emails.
- Token values aren't encoded. Tokens are inserted into the HTML as-is. If a value typed by the user contains HTML, it's rendered as HTML.
- Nested lists. Inside Execute Actions or Repeat, it also ends the actions after the enclosing list.
Examples
tip
To understand how to use the below examples, please see Running Examples.
1. Confirm a submission
This action thanks the logged-in user by name after the form is submitted.
{
"Title": "Display Message",
"ActionType": "ShowMessage",
"Description": "Show a confirmation after submission",
"Parameters": {
"Message": "<p>Thank you [User:FirstName] [User:LastName]! Your response has been submitted.</p>",
"ButtonsList": {
"Expression": "",
"Value": [],
"IsExpression": false
}
}
}
2. Show a message instead of a closed form
Add this action to the form's On Init event. When the RegistrationOpen token is No, the form isn't shown and the user sees the message instead.
{
"Title": "Display Message",
"ActionType": "ShowMessage",
"Description": "Registration is closed",
"Condition": "[RegistrationOpen] == \"No\"",
"Parameters": {
"Message": "<p>Registration is closed. Please check back next year.</p>",
"ButtonsList": {
"Expression": "",
"Value": [],
"IsExpression": false
}
}
}
Revised 09/27/2026