Webchat

Webchat profile

Configuring and managing webchat profiles

Create webchat profile

Navigate to Manage. Under Config Select Notifications
Navigate into Webchat/Webchat Profiles

Create a new profile.
Once you have completed configuring your profile name and description. Scroll to the bottom and click Create.
Manage will save your profile and refresh.
Scroll to the bottom of your new profile and Click Open webchat client. This is a quick way to test your webchat without needing to create a webpage.

Adding an SVG Icon to the Webchat Button

To customize the appearance of your webchat button, you can include an SVG icon. Here's how to configure it:

Enable the SVG Icon

In your webchat profile configuration, locate the option "Use SVG icon in 'open webchat' button" and check the box to enable this feature.

Provide the SVG URL

Enter the URL of the SVG file in the SVG URL field. Ensure the SVG is hosted and accessible via a valid URL. For example:

https://app.stubber.com/api/fileserver/file/<file-id> Save and Preview After adding the SVG URL, save your webchat profile. You can preview the webchat by opening the webchat client to verify that the SVG icon displays as expected.

Note: Ensure that the SVG file complies with the required specifications and is optimized for web use to maintain performance and visual consistency.

Testing webchat using profiles

In profiles there is 2 branches live and draft
The Draft branch will be where most testing and development is done.
The Live branch should be reserved for live environments

Opening webchat client using profile uuid

To quickly test your webchat select your branch (live or draft)
This will open a webpage with the webchat client embedded
Example of a webchat client using the live branch Live Webchat client
Example of a webchat client using the draft branch Draft Webchat client

Something to note:

When naming the webchat in a draft branch, "draft" will be automatically prefixed onto the Chat name.

Updating webchat profiles

Make sure you are on the correct branch when updating a profile (live or draft)
Changes made to both branches will automatically update