Embedding the chatbot is a very easy process. Our embed code uses only one sentence of code to paste onto your webpages. 


This section of the user guide is focused on embedding the chatbot. To help you navigate the article we have broken it down into the following sections:

Where is the embed code?


The embed code for the chatbot button can be found on the Chatbot>Embedding webpage.

Only users with administrator access can access the chatbot embed code.

For more information on user permissions, review the User Roles & Permissions article.


How do I embed the bot?

Copy and paste this HTML embed code into the Javascript area of any/all webpages where you want the chatbot button to display (i.e., if your contract is for a financial aid chatbot, embed the chatbot onto each of your financial aid webpages).



Note: To have the bot automatically load open when you visit a page, add "#bot" to the end of any URL where the bot is embedded. When you click the URL the bot will load open.


For best usage, ensure the chatbot has maximum visibility by embedding the launcher onto every applicable webpage.


Once your bot is live on your webpages, review the Post-Launch: Promote your Service article!



Note: Ocelot has new embed code available for the chatbot button.  

  • If you have previously embedded the chatbot button, we recommend you re-embed this code on all webpages where the old button exists. 


If you are using the old embed code but have set new settings on the Look & Feel and Behavior Settings pages:
  • The launcher settings associated with the old embed code will present/trump the new settings from the Look & Feel Page (because it is hard coded into the embed code itself).
  • All other settings (welcome message, live chat first, IDK behavior) will be determined by definitions on the Look & Feel and Behavior Settings pages.
  • URL matching will be the primary way conversations are associated with specific offices/departments at your school.


If you are using the new embed code:
  • All settings (launcher, welcome message, live chat first, IDK behavior) will be determined by definitions on the Look & Feel and Behavior Settings pages.
  • URL matching will be the primary way conversations are associated with specific offices/departments at your school.


    For more settings about the Look & Feel of the page, please review the Navigating the Admin: Look & Feel Page article.


Accessibility

If your website makes use of HTML5 or WAI-ARIA landmarks, the bot may trigger a warning in accessibility audits. Add "data-ocelot-target" to the appropriate HTML container element to prevent this issue. We recommend using your site’s footer as the container element.

  • Before: "<footer>… footer content here …</footer>"
  • After: "<footer data-ocelot-target>… footer content here …</footer>"


During the testing period prior to when the chatbot goes live, it is recommended to embed the bot onto a test page to ensure there are no conflicts with other existing code on your website. If you send the test page’s URL to us, we will have our Tech Team test it to ensure proper bot functionality and performance.


Note: Be aware of any existing items on your site (i.e. floating anchor buttons) that might conflict with the chatbot’s launcher once embedded.


Security


If your institution has a Content Security Policy (CSP), you may need to configure your CSP settings for the chatbot to render properly. 


For more information on Content Security Policy (CSP), please review the Embedding the bot or videos on webpages with Content Security Policy (CSP) article.