Embedding Your Bot
First, ensure that your bot has been configured to be embeddable by visiting the bot's Config page. (Unless you have changed it, the bot will default to being embeddable.) Then, look for the Tag for Embedding link just below the option for configuring whether your bot is embeddable. The tag looks something like this:
In the above example, "MyChatbot" will be the path to your bot.
Paste the entire script tag into the HTML source of your website at the spot you want it to be embedded.
Advanced options can be specified at the end of the embed URL in the form of standard CGI parameters. Current options are:
|header||0 or 1||
Whether to display a header above the chat window with the bot's avatar, name, and description. E.g.:
|height||<n> or <n><unit>||Height of the chat dialog1|
|width||<n> or <n><unit>||Width of the chat dialog1|
|maxwidth||<n> or <n><unit>||Maximum width of the chat dialog1|
|popout||0 or 1||Whether to display the chat dialog in a "popout" window on the lower right corner of the browser (default = 0, i.e. no popout).|
1 Any valid CSS unit of measurement may be used, e.g.
300 for 300 pixels, or
300pt for 300 points. For percentages, since the percent sign is not allowed in URLs, it should be encoded as
%25, so 50% would be encoded as
To specify multiple options, separate them with an ampersand (&), e.g.:
You can specify which domains may embed your bot by listing them in the Embeddable Domains window. List each domain on a separate line. For example:
They are not wildcards, so if you wish to embed your bot on multiple subdomains you must list them all explicitly (e.g. sub1.mydomain.com, sub2.mydomain.com, sub3.mydomain.com). The most common example would be if your domain will be accessed by both the www- and non-www versions (e.g. www.example.com and example.com), you should list them both.Domain names listed here are case-insensitive.
If you don't list any domains here, then any domain may embed your bot.
The following code produces the popout window you see on the lower right corner of this page: