Connecting your bot to Workplace

How to connect your bot to Workplace

Melita Gandham avatar
Written by Melita Gandham
Updated over a week ago

In order for your bot to go live on Workplace, it will have to be connected to your Workplace instance. You can connect up your bot as soon as you've created it on the platform, or after you've built out the message flow. Before you connect your bot, you will need to make sure you are an System Administrator on your Workplace instance. You can find out more about that here.

Step by step guide

1) Log in to The Bot Platform

First, go to The Bot Platform and log in. You will then be taken to your homepage.

2) Create a bot

Click the ‘Create a bot’ button in the top right corner. You will then be taken to a page where you can choose whether you want to create your bot from a selection of our templates, or start from scratch:

3) Name your bot

Once you've chosen, it's time to name your bot! Don't worry if you haven't got a final name for your bot yet - the actual name of your bot will be added when you connect your bot to Workplace later on:

You can also choose to make your bot anonymous - this allows the bot to create data anonymously. You can find out more about anonymous bots here. Once you've named your bot, you will be taken to the dashboard.

4) Connect up your bot

Once you've created your bot, you'll be taken to your dashboard where you can either connect up your bot or start building out your message flows. If you want to connect your bot up first, click the "Connect to Workplace" button to start setting up your integration:

Note before starting this step - you will need to make sure you are an System Administrator on your Workplace instance. You can find out more about that here.

5) Edit your permissions

If you are a System Administrator on your instance, then click on "I am a Workplace Admin" in order to progress to the permissions page:

Here you will find a list of permissions. We need to have these permissions approved in order for your bot to work. Two permissions are compulsory for basic bot use. Others are optional, but we highly recommend ticking them if you want to use the full set of platform functionality. Here is a list of the full Workplace permissions.

Once you're happy with your permissions, click "Next".

6) Update your integration

You will then be taken to Workplace, more specifically the integration that will launch your bot. You can customise your bot here, by updating its logo, name and description.

You can also review your permissions and choose your group based permissions. Group based permissions only grant the bot access to the groups you've selected. You can leave your bot open to all groups, which means all users on your Workplace instance can find or be sent the bot. Or you can choose specific groups, which means on the users in the group can find or be sent the bot. In my example, my feedback bot is collecting feedback from the Product Team so I have added the Product group, so only they can access the bot:

7) Save your integration

Once you're happy with your integration settings, click "Add to Workplace" in order to finish connecting up your bot. You will then be taken back to The Bot Platform where you can carry on building and editing your bot. If you need to make changes to your integration at any time, follow the steps in this help doc.


Connecting your bot to Multi-company Groups (MCGs)

Unfortunately, it is not possible to connect a bot to a multi-company group on Workplace. A bot can only be tied to one instance at a time. If you would like the bot to be present on multiple instances, you can copy your bot and set it up on each instance (dependent on if each company is paying for a TBP licence).

Did this answer your question?