SaaS Assistant Widget
The SaaS Assistant Widget puts your Sonat documentation inside your own web app or website as a help panel. Your users get help without leaving your product, and the panel can open the topic that matches the page they are on. For example, a user on your app's billing page opens the panel and sees your "Manage billing" topic.
Category: Organization · Plan: Enterprise · Requires: nothing
Set up a widget
- Open Organization Settings > SaaS Assistant Widget.
- Select Create SaaS Assistant and give it a name. You can create several assistants, for example one per product, and switch between them.
- Choose the Default Entity: the document or topic the panel shows first.
- Choose how the panel opens under Panel Type: Slider, Pop-Over, Side Drawer, or Embed. For Embed, enter the Target Element Selector of the element on your page that should hold the panel.
- Choose the Button style and its Position. The available button styles depend on the panel type.
- Under Styling, set the button text, colors, and icon.
- Turn on Activate SaaS Assistant.
- Copy the script and paste it into your app's main page.
Open the topic that matches the page
To show a specific topic on specific pages of your app, open that topic's Settings and enter a pattern in SaaS Assistant Regex. The pattern is a regular expression matched against the page's web address. For example, /settings/billing opens the topic on any page whose address contains /settings/billing. When several topics match, the first one in the topic tree is used. For more examples, see Web Assistant Simple Regex.
Open the panel from your own button
To open the panel from an element in your app, such as a help icon in your menu, add the attribute data-swa-paneljstrigger to that element.
Private documentation
If the content the widget shows is private, choose a Share link, or create one, so your users can read it inside the panel. Without a share link, users only get a link that opens the documentation in a new tab. Anyone who views your page's source code can see the share link.
For more setup details, see Web Assistant.
If you uninstall it
The SaaS Assistant Widget settings tab and the topic regex field are hidden. Your settings are kept. To remove a widget from your site, remove the script from your app, or select Delete Current SaaS Assistant before uninstalling.