Add a widget in the Portal Banner widget

task australia Updated Sep 10, 2026 1 min read portal-banner-option-schema.md

Add a widget for additional functionality to the Portal Banner widget and configure it. For example, you could add the Portal Quick Links widget to enable users to access knowledge articles, external URLs, catalog items, or custom pages from the Portal Banner widget.

Before you begin

The UI Components for Customer Portals plugin must be installed. For more information, see Activate the UI Components for Customer Portals plugin.

Role required: sp_admin

Procedure

Navigate to your portal home page.
On the widget you want to add, press Control+right-click.
In the context menu, select Instance in Page Editor.
In the Edit section, select the Portal Quick Links widget from the flowchart.

The Portal Quick Links widget has been considered as an example.
Select the Instance 2.
Copy the JSON code from the Additional options, JSON format field.
On your portal home page, press Control+right-click on the Portal Banner widget..
Select Instance Options.
In the Behavior section, paste the JSON code into the Widget Option Schema field.
In the Widget Option Schema field, modify the JSON code to update the configuration of the widget that you've added.

For more information on each JSON parameters of the Portal Quick Links widget, see Portal Banner widget JSON parameters.
Select Save.

54 lines · 2.6 KB Wrap lines

---
title: Add a widget in the Portal Banner widget
description: Add a widget for additional functionality to the Portal Banner widget and configure it. For example, you could add the Portal Quick Links widget to enable users to access knowledge articles, external URLs, catalog items, or custom pages from the Portal Banner widget.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/australia/customer-service-management/customer-self-service-and-omnichannel-engagement/portal-banner-option-schema.html
release: australia
product: Customer Self-service and Omnichannel Engagement
classification: customer-self-service-and-omnichannel-engagement
topic_type: task
last_updated: "2026-09-10"
reading_time_minutes: 1
breadcrumb: [Portal Banner widget, Set up Configurable Portal widgets, Set up self-service, Configure, Customer Service Management]
---

# Add a widget in the Portal Banner widget

## Before you begin

The UI Components for Customer Portals plugin must be installed. For more information, see [Activate the UI Components for Customer Portals plugin](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/customer-service-management/customer-self-service-and-omnichannel-engagement/activate-config-portal-widget.md).

Role required: sp\_admin

## Procedure

1. Navigate to your portal home page.

2. On the widget you want to add, press Control+right-click.

3. In the context menu, select **Instance in Page Editor**.

4. In the Edit section, select the Portal Quick Links widget from the flowchart.

The Portal Quick Links widget has been considered as an example.

5. Select the **Instance 2**.

6. Copy the JSON code from the **Additional options, JSON format** field.

7. On your portal home page, press Control+right-click on the Portal Banner widget..

8. Select **Instance Options**.

9. In the **Behavior** section, paste the JSON code into the **Widget Option Schema** field.

10. In the **Widget Option Schema** field, modify the JSON code to update the configuration of the widget that you've added.

For more information on each JSON parameters of the Portal Quick Links widget, see [Portal Banner widget JSON parameters](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/customer-service-management/r-port-banner-widget-json-schema.md).

11. Select **Save**.