Define the payload for a custom modal

Set your action button to open a custom modal by defining the payload parameters.

Before you begin

• Create a form action
• Open your record page in UIB or create a page variant in UIB
• Design your page variant in UIB
• Configure your page variant as a modal in UIB
• Create a UX add-on event mapping

Role required: admin

Procedure

1. In the navigation filter, navigate to All > Declarative Actions > Form Actions.
2. Select the form action where you want to add the custom modal.
3. Open the Specify client action field by selecting the record preview icon () and Open Record.
4. Mark the location of your page by entering the page's action name as the route key of the Payload field.
5. Pass variables from the current context by entering the table and sysID values in the fields key.

    {
      "route": "action-name",
      "fields": {
        "table": "{{table}}",
        "sysId": "{{sysId}}"
      }
    }

6. Select Update.
7. Open a record in your configurable workspace.
8. Test your button by selecting it.
   Your button opens the custom modal.