Tenjin uses the Microsoft Bot Framework webchat client. Sample code to embed the assistant is provided via the Channels page.
Inline help is available with detailed guidance on additional options.
The following topics are covered by this article:
To make Tenjin available on a web page, the Webchat channel is required. The steps below will show you where to find both the IFrame and Script versions of the code that you will need to publish your assistant.
Accessing the Code
- Navigate to your assistant.
- Click the Webchat link on the main assistant panel.
- You will then see the two snippets of code, similar to the screengrab above.
Embed Script
Embed Script is the recommended method of embedding Tenjin in your website. The code supplied demonstrates how to embed the webchat client using a JavaScript call along with some simple styling options.
There are many options available when it comes to styling the client, more than what we've included in our sample, for example, colors, fonts, spacing, and buttons. For more details on the customization options, please see the documentation on the Microsoft GitHub repository using the following links:
- https://github.com/microsoft/BotFramework-WebChat/blob/v4.15.1/packages/api/src/defaultStyleOptions.ts
- https://github.com/microsoft/BotFramework-WebChat/blob/v4.15.1/packages/api/src/StyleOptions.ts
Embed IFrame
Although not our recommended approach, you also have the ability to embed the assistant on your website by using an IFrame. This can be a simpler approach and does have some advantages over the Script option, such as the ability to display Tenjin in a pop-up, but it does reduce the styling options within the assistant.
Persistent Users
If you wish your bot to remember your user from session to session, then you must implement persistent users. The detailed inline help describes implementing persistent users.
Adding a Channel
- Click the +Add Channel button on the right-hand side to add a channel.
Share this article
Comments
0 comments
Article is closed for comments.