---
sourceDocument: Australia Customer Service Management
sourceDocumentLink: https://www.servicenow.com/docs/r/customer-service-management

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Customer Service Management

ft:clusterId :

    - csm

bundleId :

    - csm

workflow :

    - Customer and Industry


---

# Configure the Catalog item component instance

# Configure the Catalog item component instance {#ariaid-title1}

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

Configure the Catalog item component instance so that your users can embed it on their website to request an item or service from their website.

## Before you begin

You must have the following setup to configure the Catalog item component instance:

* Enable Web Embeddables in your instance. For more information, see [Activate Web Embeddables](https://www.servicenow.com/docs/SncFxfwSEtIvlpyyqmxz2Q "You can enable the ServiceNow Components for Customer Service (sn_cx_components), Web components for Guest Embeddables (sn_guest_component), and Web Embeddable Core (sn_embeddable_core) to enable Web Embeddables on your instance. The application establishes related plugins if they aren’t already installed.").
* [Set up a custom URL as the instance URL](https://www.servicenow.com/docs/AUV_G7eDelxzB0TOTC77XQ "Add a custom URL to your instance configuration to use instead of your ServiceNow URL. This custom URL ensures that embedded components remain accessible in your browser, even when third-party cookies are turned off.").
* Authenticate the ServiceNow components using OpenID Connect (OIDC) or non OIDC authentication. For more information, see [Authenticate the ServiceNow components using OIDC](https://www.servicenow.com/docs/2qubcZxyeA~7lMiUblY_1A "Set up auto-login and log out using OpenID Connect (OIDC) authentication to enable single and simultaneous login and logout in your website and embedded components.") and [Non OIDC authentication for ServiceNow components](https://www.servicenow.com/docs/NSuUm~8N16GNvUb_7cANqA "Generate a JSON Web Token (JWT) token to authenticate your ServiceNow components if your website doesn’t use OpenID Connect (OIDC) authentication.").
{#configure-catalog-item-component-on-instance__ul_brf_cqf_ccc}

Role required: sn_embeddable_core.emb_admin

## Procedure

1. Navigate to AllWeb EmbeddablesHomepage.
2. In the homepage, select Create module or use the existing module.  
   For more information on creating a module, see [Create a module](https://www.servicenow.com/docs/cUVM5bfe0riPnY~5QKYQVg "Create a module to manage component instances used in a website. You can either create a module or use a prebuilt module and edit it according to requirement.").
3. On the module page, in the Components tab, add a Catalog item component instance to an existing or a new group.  
   For more information on creating a group and then adding a component instance, see [Create a group and add a component instance](https://www.servicenow.com/docs/0FL_ZYd~25yNfBreXHKjVQ "Create a group to model third-party website structure such as page or sections. Use the default group or create new groups to manage the component instances on that page or section.").
4. **Optional:** Toggle the Show static preview option to see a visual representation of a component when a live preview isn't available.  
   Note:  
   When enabled, any changes to the global or component properties don't appear in the Preview tab in real-time.
5. Configure the Catalog item component instance properties.  
   * The Preview tab displays real-time data according to choices set in the component properties.
   * For a description of the component properties related to the Catalog item component instance, see [Component properties for the Catalog item](https://www.servicenow.com/docs/TcdpT7H8UFZREAAIESesOQ "Component property enables you to configure the behavior of the Catalog item component instance on the third-party website.").
   {#configure-catalog-item-component-on-instance__ul_jlw_yjw_cfc}
6. Select the CORS rules tab to configure the CORS rules.  
   For more information about configuring CORS rules, see [Configure CORS (Cross-Origin Resource Sharing) rules before embedding ServiceNow components](https://www.servicenow.com/docs/mgugMWeiw1SNjGgjJDaCOQ "Configure a CORS rule to enable cross-domain requests between ServiceNow components and the website that you want to embed the web components.").
7. Select the Components tab.  
   If a message appears about the application scope, change the scope to Web Components for Customer Service to be able to edit the record.
8. Select the Get embed code.  
   A pop-up window appears to display both Global code and Component code.
9. In the Global code tab, review the generated code and select the Copy global code.  
   The global code must only be added once to your third-party webpage.

       import { init, login, logout, startGuestSession } from 'https://demo.servicenow.com/uxasset/externals/sn_embeddable_core/index.jsdbx';

       await init({
           theme: 'fad87d2ca304121029a4d1aed31e610f',  /* sys_id of the theme to use for the embeddable components in your website */
           baseURL: 'https://demo.servicenow.com', /* Base URL of the instance to be used for the embeddable components in your website */
           authCallback: getTokenCallBack, /* Function which returns the auth token for the current user, required for auth setup */
           module: '591800ffc1243610f87714367ed47c6a', /* Demo module */
           pageName: document.title, /* Uses the browser's document title as the page name in User analytics experience */
           guestTokenCallback: getGuestJWTTokenCallBack, /* Function which returns the guest token for the current user, required for guest validation setup */
           cacheComponents: [] /* Pre-caches resources for improved performance. Update component list as per your usage */
       });

       function getTokenCallBack() {
           var idToken; /* Get the id token for the current user */
           return Promise.resolve(idToken);
       }

       function getGuestJWTTokenCallBack() {
           var guestToken; /* Get the guest token for the current user */
           return Promise.resolve(guestToken);
       }

       /* Uncomment below function to handle guest session */
       // await startGuestSession();

       /* Uncomment below functions to handle login and logout once the user logs into your website */
       // await login();
       // await logout();

10. **Optional:** In the Component Code tab, slide the Enable event handler toggle switch to handle events triggered by the user interactions on the webpage.  
    Note:  
    Enabling the event handler also modifies the component code. For more information on event handlers in Web Embeddables, see [Event handler in the Catalog item component](https://www.servicenow.com/docs/WiatSNq3h5rrYeM9bFC~xg "A component triggers an event when a certain condition is met or on user interaction. The event can be used to execute an action through a code on a third-party webpage.").
11. In the Component code tab, review the generated code and select the Copy component code.  
    This generated code also includes event handlers.

        <!--  
            Module: Demo module
            Group: Group 1
            Instance: Catalog item 1
        -->
        <sn-embedx-catalog-item-form
        	sys-id="56c62944c30102003d3b7bfaa2d3ae36"
        	confirmation-text="Request submitted successfully!"
        	confirmation-sub-text="Estimated resolution in 24 hours"
        	reference-number-label="Reference Number :"
        	primary-button-label="View details"
        	secondary-button-label="Browse services">
        </sn-embedx-catalog-item-form>
        <!--
        	The component also includes the following additional properties:
        	hide-reference-number
        	hide-primary-button
        	hide-secondary-button
        	hide-record-created-confirmation
        	hide-errors
        	hide-notifications
        -->

        <script type="module">
        	import { getEmbeddables, setEvents, setProperties } from 'https://demo.servicenow.com/uxasset/externals/sn_embeddable_core/index.jsdbx';
        	
        	const snEmbedxCatalogItemForm = document.querySelector('sn-embedx-catalog-item-form');

        	/* Uncomment this code for the default behaviour of the Catalog item component.

        	// Get the catalog item record id from the current URL.
        	// Optionally, get query to pre fill the form.
        	const currentURL = new URL(window.location.href);
        	const urlParams = new URLSearchParams(currentURL.search);
        	const account = urlParams.get('emb_account');
        	const preferred_language = urlParams.get('emb_preferred_language');
        	// Update the sysId of the component property.
        	// Optionally, update the prefill fields property
        	const prefillConfig = {
        			account: account,
        			preferred_language: preferred_language
        	};
        	setProperties(snEmbedxCatalogItemForm,{
        		prefillFields: prefillConfig
        	});
        */

        	getEmbeddables(["sn-embedx-catalog-item-form"]);

        	const eventHandlers = {
        		'SN_EMBEDX_CATALOG_ITEM_FORM#RECORD_CREATION_FAILED' : (e) => {
        			// This event is dispatched if the record creation has failed.
        		},
        		'SN_EMBEDX_CATALOG_ITEM_FORM#COMPONENT_NOTIFICATION_SENT' : (e) => {
        			// This event is dispatched when the component provides a notification for the end user.
        			var {items} = e.detail.payload;
        			console.log(items);
        		},
        		'SN_EMBEDX_CATALOG_ITEM_FORM#COMPONENT_READY' : (e) => {
        			// This event is dispatched when a component is ready and usable.
        		},
        		'SN_EMBEDX_CATALOG_ITEM_FORM#RECORD_CREATION_SUCCEEDED' : (e) => {
        			// This event is dispatched if the record was successfully created.
        			var {table, record_sys_id} = e.detail.payload;
        			console.log(table, record_sys_id);
        		},
        		'SN_EMBEDX_CATALOG_ITEM_FORM#BUTTON_CLICKED' : (e) => {
        			// This event is dispatched if any button is clicked on the confirmation message.
        			var {table, record_sys_id, button_variant} = e.detail.payload;
        			var primaryURL =  '/caseview'; // Replace with the URL of the case view page
        			var secondaryURL = '/browse'; // Replace with the URL of the secondary page

        			if(button_variant == 'primary') {
        				// Construct the URL for the Case View component with URL parameters
        				const caseViewURL = primaryURL+'?emb_table='+table+'&emb_recordid='+record_sys_id;
        				open(caseViewURL,'_self'); // Open case record when primary button is clicked
        			}
        			else {
        				// Open the Case View component in the same tab
        				open(secondaryURL,'_self');
        			}
        		},
        		'SN_EMBEDX_CATALOG_ITEM_FORM#COMPONENT_ERROR' : (e) => {
        			// This event is dispatched when a property validation or internal error occurs.
        			var {errorMessage, errorType} = e.detail.payload;
        			console.log(errorMessage, errorType);
        		}
        	};

        	setEvents(snEmbedxCatalogItemForm, eventHandlers);
        </script>

{#configure-catalog-item-component-on-instance__steps_kkl_1fn_ccc}

## Result

The global and component codes are ready to be shared with the third-party administrator to embed the Catalog item component instance on their third-party website.

## What to do next

[Embed the Catalog item component instance on the third-party website](https://www.servicenow.com/docs/d3RyVEBKRIYzzTSITFz8EA "Embed the global code and component code of the Catalog item component instance that you configured so that you can enable your customers to start using the Catalog item component instance on your third-party website.")
**Related reference**   

* [Component properties for the Catalog item](https://www.servicenow.com/docs/TcdpT7H8UFZREAAIESesOQ "Component property enables you to configure the behavior of the Catalog item component instance on the third-party website.")
* [Event handler in the Catalog item component](https://www.servicenow.com/docs/WiatSNq3h5rrYeM9bFC~xg "A component triggers an event when a certain condition is met or on user interaction. The event can be used to execute an action through a code on a third-party webpage.")
* [Sample code for the Catalog item component](https://www.servicenow.com/docs/EPkyK_lBBZh8DiBhM8Cj1A "Sample code is provided to define an action when an event is triggered. Update the sample code for your use case before embedding the component on your webpage.")

*[\>]: and then