Launch an Onboarding Modal
task australia Updated Sep 10, 2026 1 min read launch-onboarding-modal.md
Launch an Onboarding Modal you have created in your instance.
Before you begin
Role required: admin
Procedure
-
To launch an Onboarding modal once created, do the following:
-
Create a client script in UIB.
-
Under code snippet enter
api.emit('SN_HELP#GUIDANCE_START_REQUESTED',{guidanceId:"ID"}); -
Replace the ID with the sys_ID of the modal guidance to be opened.
-
Save the page.
-
Select Body in the left panel of the UIB page.
-
In the right panel, select the Events tab.
-
Under Dispatched Events select Add.
-
In the event name, add
SN_HELP#GUIDANCE_START_REQUESTEDand give the label with a name. -
Select Save.
Parent Topic:Onboarding modals
48 lines · 1.4 KB
---
title: Launch an Onboarding Modal
description: Launch an Onboarding Modal you have created in your instance.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/australia/platform-user-interface/adoption-services/launch-onboarding-modal.html
release: australia
product: Adoption Services
classification: adoption-services
topic_type: task
last_updated: "2026-09-10"
reading_time_minutes: 1
breadcrumb: [Onboarding modals, Adoption services, Configure user experiences]
---
# Launch an Onboarding Modal
Launch an Onboarding Modal you have created in your instance.
## Before you begin
Role required: admin
## Procedure
1. To launch an Onboarding modal once created, do the following:
2. Create a client script in UIB.
3. Under code snippet enter `api.emit('SN_HELP#GUIDANCE_START_REQUESTED',{guidanceId:"ID"});`
4. Replace the ID with the sys\_ID of the modal guidance to be opened.
5. Save the page.
6. Select **Body** in the left panel of the UIB page.
7. In the right panel, select the **Events** tab.
8. Under **Dispatched Events** select **Add**.
9. In the event name, add `SN_HELP#GUIDANCE_START_REQUESTED` and give the label with a name.
10. Select **Save**.
**Parent Topic:**[Onboarding modals](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-user-interface/adoption-services/next-experience-onboarding.md)
| title | Launch an Onboarding Modal |
| description | Launch an Onboarding Modal you have created in your instance. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/australia/platform-user-interface/adoption-services/launch-onboarding-modal.html |
| release | australia |
| product | Adoption Services |
| classification | adoption-services |
| topic_type | task |
| last_updated | 2026-09-10 |
| reading_time_minutes | 1 |
| breadcrumb | Onboarding modalsAdoption servicesConfigure user experiences |