# What are Custom Workbots?
Custom Workbots are Microsoft Teams apps you create that can leverage the Workato bot platform under the hood. You can fully customize your bot's identity, i.e.:
- Branding (bot name, bot logos, accent color)
- Custom OAuth profile (bot ID, App secret)
These Microsoft Teams apps can then be sideloaded into your Microsoft Teams groups or channels for use by your members.
# When would I need custom Workbots?
- You want multiple, purpose-specific bots in your Microsoft organization. For example, you may want to have HRBot, ITBot, DevOps bots installed within your organization.
3 bots installed into 1 Microsoft organization
- You want control over your bot's branding, i.e. bot name, bot logos (full color & transparent outline) and accent color,
- You want control over your bot's permissions. By default, Workbot for MS Teams requests for a minimum set of permissions:
Your custom bot can additionally include:
# Creating a custom Workbot
Before you begin, ensure that you have been assigned at least one of the following roles in your Microsoft organization:
Application administrator Cloud application administrator Global administrator Privileged role administrator
You can check your role assignments from https://portal.azure.com/ (opens new window) ➤ Users ➤ You (click on your name) ➤ Assigned roles.
Check your assigned roles
# Getting started
To begin, head to Tools ➤ Workbot.
If you don't see Workbot, make sure your Workato team or account has access to Workbot
In the Custom tab, at the bottom of the page, click on Create a custom bot.
Missing custom tab
If you don't see the Custom tab, make sure your Workato team or account has access to Custom OAuth profiles
# Step 1: Create a bot in Microsoft App Studio
Step 1 is done entirely on App Studio in Microsoft Teams.
|1||Install App Studio||In MS Teams, from the left navigation bar, click the ellipsis, then search & install App Studio.|
|2||Create new app||In App Studio, navigate to the Manifest editor tab, and click Create new app.|
|3||Key in app details||Key in the following fields in your App details:|
|4||Capabilities: Add personal tab(optional)||
Click on Add a personal tab and fill in the following fields:
|5||Obtain Client ID||Under Capabilities ➤ Bots, click Set up.|
|6||Obtain Client secret||Under App passwords, click on Generate new password.|
Once you've obtained both the Client ID and the Client secret, head back to Workato. Proceed to Step 2.
# Step 2: Configure the custom OAuth profile
|1||Under Bot name, key in your bot's name.|
|2||Under Client ID, copy your Bot ID and paste it into the field.|
|3||Under Client secret, copy App password and paste it into the field.|
# Step 3: Configuring your custom bot to talk to Workato
Copy the Messaging endpoint, and head back to MS Teams App Studio.
|1||Configure messaging endpoint|
|2||Whitelist Workato as a valid domain|
After adding the
|3||Test and distribute: resolve outstanding issues||On the right side of the page, resolve any outstanding issues. If left unresolved, you may run into issues with installation and/or downloading your app package (a.k.a. manifest).|
These issues are typically related to fields in Details ➤ App details and/or Capabilities ➤ Bots.
|4||Test and distribute: download manifest||Click on Download to download your app's manifest into your default download folder. Keep this file handy - you'll need it for the next step.|
|5||Sideload app: Go to MS Teams admin center||Head over to https://admin.teams.microsoft.com/policies/manage-apps (opens new window)|
|6||Sideload app: Upload manifest|
|7||Sideload app: Add to team or channel|
# Step 4: Configure redirect URLs for authentication
|1||Got to portal.azure.com (opens new window)|
|2||Add the redirect URIs|
# Step 5: Establishing a Workbot connection with a custom Workbot
|1||Go to App connections|
# Common issues: MS Teams Permissions & Setup policies
If you encounter permissions issues when sideloading your app in the MS Teams admin center (opens new window) or during authentication, please check the following settings in the MS Teams admin center (opens new window).
|1||Org-wide app settings|