This page is about Chat for JSM Cloud. Using Server or Data Center? Click here.
The Chat Widget installation process is pretty simple. On this page, you’ll learn how to add the Chat Widget to your website.
How to Add Chat Widget on a Website
Navigate to the project you'll use to manage the service requests coming from the Chat Widget and open its Project Settings.
From the sidebar, click Chat Settings > Chat Widget.
Click Install.
This will open a pop-up with installation instructions. Copy the installation code to the clipboard.
Contents |
|---|
Open your website’s backend. Access the server where your website is hosted using the tool that allows you to modify files or log in to your platform's dashboard.
Locate the file that contains the </body> tag.
While it might differ depending on how your website is built, the rule of thumb would be to search for the files with .html or .php extension. Usually, it will be either index.html or index.php, but there might also be some additional subpage files.
Find the </body> tag, and add the JavaScript code you’ve copied before it.
Paste your JavaScript code snippet above the closing </body> tag of your website's source code.
Save the changes.
Go back to the Installation instructions and click Enable Chat Widget.
Check your website to make sure the widget has appeared.
Can’t see the widget on your website? Try these out:
Make sure you’ve enabled Chat for the project on the Chat Settings > General Settings page
Double-check the code changes
Verify widget visibility settings
Repeat the steps described above(“How to Add Chat Widget on a Website”) to make sure you’ve followed them correctly
Contact our support
Tada! 🎉 You have successfully integrated the Chat Widget with your website! You can now modify its appearance to fit your brand by changing the code.
How to Secure Your Chat Widget with Trusted URL(s) Feature
The Trusted URL(s) feature is an optional security measure that allows you to specify the specific website(s) where your Chat Widget should appear. This feature helps to prevent malicious actors from embedding the Chat Widget on unknown websites and potentially using it to impersonate your organization.
To use the Trusted URL(s) feature:
Navigate to the Project Settings > Chat Settings > Chat Widget page.
Under Website, you will see an option to add the URL(s) of websites where your Chat Widget should appear.
Simply enter the URL(s) in the provided field. Ensure you add the correct protocol before your web address (e.g.,
https://).Click Save to apply the changes.
Please note that if you choose to skip this step, your Chat Widget may be embedded on unknown websites, potentially leading to security risks. We recommend that you use this feature to ensure the security of your Chat Widget.
How to Automatically Open Chat Widget on Page Entry
The Auto-Open Widget setting allows the Chat Widget to automatically open on an external web page when visitors access the page. This feature eliminates the need for customers to manually click on the widget icon, offering a more immediate and engaging interaction.
This feature exclusively applies to the Chat Widget embedded on external web pages and won't affect its behavior within customer portals.
To enable the Auto-Open Widget setting, follow these steps:
Navigate to the Project Settings > Chat Settings > Appearance > (Under Website) Auto-Open Widget.
Click the checkbox next to the Automatically open the Chat Widget when customer visits website option.
Don't forget to click Save to apply the changes.
That's it! If you ever wish to revert to the default behavior (where the widget must be manually opened), simply return to the "Auto-Open Widget" setting and uncheck the box.
Recommended Content-Security-Policy Header Values
The Chat Widget connects to several external services to load necessary resources and achieve live delivery of chat messages. The host page needs to set at least the following Content-Security-Policy header value to make it work:
style-src 'self' 'unsafe-inline' https://spartezchatfiles.b-cdn.net; connect-src 'self' wss://chat-ws.spartez-software.com/ https://api.ipify.org https://spartezchatfiles.b-cdn.net https://chat-api.spartez-software.com https://spartez-chat-attachments-prod.s3.eu-central-1.amazonaws.com/ https://s3.eu-central-1.amazonaws.com/spartez-chat-attachments-prod https://appsync-api.spartez-software.com wss://appsync-api.spartez-software.com ; img-src 'self' data: https://* ; media-src 'self' data: https://spartezchatfiles.b-cdn.net;
The wildcard directive on img-src is required to load user avatars that can come from many different sources.
Chat for Jira Service Management is actively developed, so the recommended Content-Security-Policy value might change in the future.