Tutorial

To get started with WidgetBot, first you must invite the bot to your server.

Need help?

If you need any assistance adding WidgetBot, please ask in the server (opens new window). However, please make sure you mention what the issue is, send your code in a codeblock (```), include your server and channel IDs, and optionally include a link to your site.

Adding the Bot

Add the official bot (opens new window)

Important

WidgetBot will not work if you don't add the bot to your server!

Quick Setup

You can use the /setup command to quickly setup WidgetBot!

After you add the bot to your server, you need to pick a format to use in your website.
You can choose between Crate and one of our inline formats.

Formats

• Crate (recommended): Shows a little chat button in the corner of your website. It shows message notifications and provides an API. Tutorial, Documentation

Inline formats

These let you put a chat box in your site you can change the size, etc.

• html-embed: A lightweight iframe wrapper which provides access to the embed-api. Requires JavaScript. Tutorial, Documentation
• react-embed: Provides access to the embed as a React component, and lets you use the embed-api. Documentation
• iframe: Use this when you can't use JavaScript. It does not provide access to the embed-api, and may break the browser back button. Tutorial

Choose one of the formats to continue the tutorial and learn about adding the embed to your website.