Share your bot
Share
By default, your bot will be set to Private and can only be used in Slack. To allow people outside your organization to use the bot, you have to make it Public.
The first time you click Share, you will always get this popup.
If you select "Share Settings", your screen will look like this:
There is a lot to unpack on this screen, so let's start with the main sections.
On the left side is a menu of options for configuring and managing your bot.
On the right side is your actual bot. You can ask it questions and see how it operates. This can be useful as you're making configuration changes and want to see the impact they have on the bot. For some changes, you might have to refresh your screen to see them activated.
Finally, in the middle is where you actually make changes to the configuration and review the content.
As seen above, we did NOT select the option make the bot Public, we selected Share Settings. So, we only see the option to make it Public and the Bot ID. You will need the Bot ID if you are accessing the bot programmatically.
If you leave the toggle at the top set to Private, when you click the button to "Get Your Share Code", you will be shown the same prompt we saw earlier indicating that your bot is set to private.
If you toggle from Private to Public, you will see some changes.
The section for Allowed URLs will appear. You have the option to Enable your bot everywhere (the default setting) OR only on selected URLs. This is how you can restrict the bot so that it only works on particular websites.
If you toggle off the "Enable everywhere" option, you will have to enter the URLs where you want it to work. As you add URLs, they will appear in a list. If you want to remove a URL, you can click the icon on the right (universal symbol for delete).
Whether you have added URLs or simply made your bot Public, the Get Your Share Code button now gives a different result. When you click it, you will see your options for deploying the bot.
There are three different ways to deploy your bot:
Webpage - this is a simple webpage page that displays your bot. You can share the link with anyone and they can access it there. Add the link to any page on a site and it will open a new browser tab with your chatbot. Click the View button on the right to see how it will appear.
Popup Chat - this is intended to be used when you want to add a chatbot to your website. It inserts a chat icon onto each page. When someone clicks it, a chat window opens up. By default, the icon will be added to the lower right corner of the site.
If you add the script as part of your page headers, it can be included on every page of your site. Alternatively, you can add the code to an individual page if you only want it to appear there.
If you click the "Customize" button on the right, you will be taken to a new page to update those options. Those details are covered in the Manage Your Bot - Customize section of the Help Documentation (coming soon).
Embedded (iframe) - this is used if you want to embed the full chat window on your website without a popup. The iframe code has some default settings, but these can be customized by your webmaster to match your site requirements.
By default, your bot will be set to Private and can only be used in Slack. To allow people outside your organization to use the bot, you have to make it Public.
The first time you click Share, you will always get this popup.
If you select "Share Settings", your screen will look like this:
There is a lot to unpack on this screen, so let's start with the main sections.
On the left side is a menu of options for configuring and managing your bot.
On the right side is your actual bot. You can ask it questions and see how it operates. This can be useful as you're making configuration changes and want to see the impact they have on the bot. For some changes, you might have to refresh your screen to see them activated.
Finally, in the middle is where you actually make changes to the configuration and review the content.
As seen above, we did NOT select the option make the bot Public, we selected Share Settings. So, we only see the option to make it Public and the Bot ID. You will need the Bot ID if you are accessing the bot programmatically.
If you leave the toggle at the top set to Private, when you click the button to "Get Your Share Code", you will be shown the same prompt we saw earlier indicating that your bot is set to private.
If you toggle from Private to Public, you will see some changes.
The section for Allowed URLs will appear. You have the option to Enable your bot everywhere (the default setting) OR only on selected URLs. This is how you can restrict the bot so that it only works on particular websites.
If you toggle off the "Enable everywhere" option, you will have to enter the URLs where you want it to work. As you add URLs, they will appear in a list. If you want to remove a URL, you can click the icon on the right (universal symbol for delete).
Whether you have added URLs or simply made your bot Public, the Get Your Share Code button now gives a different result. When you click it, you will see your options for deploying the bot.
There are three different ways to deploy your bot:
Webpage - this is a simple webpage page that displays your bot. You can share the link with anyone and they can access it there. Add the link to any page on a site and it will open a new browser tab with your chatbot. Click the View button on the right to see how it will appear.
Popup Chat - this is intended to be used when you want to add a chatbot to your website. It inserts a chat icon onto each page. When someone clicks it, a chat window opens up. By default, the icon will be added to the lower right corner of the site.
If you add the script as part of your page headers, it can be included on every page of your site. Alternatively, you can add the code to an individual page if you only want it to appear there.
If you click the "Customize" button on the right, you will be taken to a new page to update those options. Those details are covered in the Manage Your Bot - Customize section of the Help Documentation (coming soon).
Embedded (iframe) - this is used if you want to embed the full chat window on your website without a popup. The iframe code has some default settings, but these can be customized by your webmaster to match your site requirements.
Updated on: 15/01/2024
Thank you!