---
sourceDocument: Australia ServiceNow AI Platform user interface
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/platform-user-interface

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia ServiceNow AI Platform user interface

ft:clusterId :

    - platux

bundleId :

    - platux

workflow :

    - Platform


---

# Configure a custom form modal

# Configuring a form action to open a custom modal {#ariaid-title1}

* Release version: Australia
* 
* Updated March 12, 2026
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

Configure a form action to open a custom modal that provides information or interactive elements without navigating away from the current page.
Configuring an action button to open a custom modal involves several processes:

1. Opening your record page in UI Builder:Accessing your record page in UI Builder enables you to design and configure the page variant with a custom modal. For more information, see [Create a page variant](https://www.servicenow.com/docs/access?context=create-variant&version=australia&pubname=australia-application-development&ft:locale=en-US).

2. Designing the page variant in UI Builder:Using UI Builder to design a page variant passes the modal into the workspace record page. For more information, see [Design a page variant in UIB](https://servicenow-prod.fluidtopics.net/7taW276LyjBclxMMJqgiEg#design-a-page-variant-in-uib "Configure a UI Builder page variant to pass from a workspace modal into the variant. This step acts as part of the process to configure an action button to open a custom modal.").

3. Configuring the page variant as a modal in UI Builder:Using UI Builder to configure the page variant defines the modal to appear in the workspace record page. For more information, see [Configure a page variant as a modal in UIB](https://servicenow-prod.fluidtopics.net/gi6FoscdfIxJyGlyTxbNFg#configure-a-page-variant-as-a-modal-in-uib "Define your page variant to appear as a modal using UI Builder configurations. This steps acts as part of the process to configure an action button to open a custom modal.").

4. Creating a UX add-on event mapping:Setting up a UX add-on event mapping connects the action button to your custom modal. For more information, see [Create a UX add-on event mapping](https://servicenow-prod.fluidtopics.net/6EYsWYID25LamuooXaIL9w#create-a-ux-add-on-event-mapping "Connect a button to a modal using UX add-on event mapping in order for an action button to open a custom modal.").

5. Defining the payload for a custom modal:Configuring the payload sets the action button to open the custom modal in your workspace. For more information, see [Define the payload for a custom modal](https://servicenow-prod.fluidtopics.net/iVZryzYFo5_fGtiA1Q1jVA#define-the-payload-for-a-custom-modal "Set your action button to open a custom modal by defining the payload parameters.").

{#configuring-an-action-button-to-open-a-custom-modal__ol_lb2_4hn_21c}