# Getting started with Workbot for Microsoft Teams by Workato
# Workbot for Microsoft Teams
Workbot is a bot platform built on top of Workato to help you run business workflows directly from Microsoft Teams.
You can initiate business workflows from Microsoft Teams by using Workbot commands. When the command is sent to Workbot (through direct messages or channels), it searches for the corresponding workflow in Workato and executes the workflow steps.
Sending a 'view_opportunities' command. The retrieves the open opportunities in Salesforce, then sends a reply
You can combine business workflows with Workbot to retrieve, create, and update data across all your apps directly within Microsoft Teams. Workato refers to these workflows as Recipes.
# Recipes
Recipes are automated workflows built by users that can span multiple apps.
Each recipe contains a Trigger and one or more Actions that are carried out when a trigger event occurs.
Recipe example
# Workbot commands
Commands allow you to run recipes from Microsoft Teams. Recipes can then perform actions in your apps, for example, creating new ServiceNow tickets or listing Salesforce opportunities.
A recipe configured with a 'newissue' Workbot command
Refer to Workbot commands for more information.
# Setup Workbot
# Requirements
To use Workbot for Microsoft Teams, a Microsoft work or school account (opens new window) is required. Accounts must be created by your organization’s administrator to enable a member of your organization access to all Microsoft cloud services such as Microsoft Azure, Office 365, Microsoft Teams, and more.
PERSONAL ACCOUNTS NOT SUPPORTED
Microsoft accounts created for personal use are not typically supported.
# Microsoft Graph permissions
To perform optimally, Workbot for Microsoft Teams requires the following Microsoft Graph permissions (opens new window). Refer to the following table for a list of recommended Graph permissions.
| Permission | Type | Why Workbot needs it |
|---|---|---|
| User.Read | delegated | Retrieves the authenticating user's user ID and user name to keep track of who installed the bot. |
| User.ReadBasic.All | delegated | Retrieves information about users. |
| Channel.ReadBasic.All | delegated | Lists channels in the Post message / Post simple message actions. |
| Team.ReadBasic.All | delegated | Retrieves organization ID and name to keep track of where bot is installed. |
| offline_access | delegated | Allows us to refresh tokens. |
| AppCatalog.Read.All | delegated | Required for retrieving installed App ID for user from Microsoft Teams app catalog. |
| TeamsAppInstallation.ReadWriteAndConsentSelfForUser | delegated | Required for installing Workbot in personal scope. Allows for the sending of proactive messages to users. |
# Install requirements
To install Workbot into your Microsoft organization, you must have one of the following roles assigned:
- Application administrator
- Cloud application administrator
- Global administrator
- Privileged role administrator
Administrator Assigned Roles
Note that installing as a global administrator optionally allows you to Consent on behalf of the organization during installation. This is particularly useful as it allows users to reconnect Workbot (in Workato) without requiring an admin user during authentication.
Extra checkbox to consent on behalf of organization when installing as global admin
# Connection set up
Complete the following steps to connect Workbot for Microsoft Teams to Workato.
Open Microsoft Teams, go to the top search bar, and search for Workbot.
Search for Workbot
- Alternatively, you can go to Apps at the bottom of the left navigation bar, search for
Workbot, and select Add for me.
Add for me
Start a direct message conversation with Workbot by typing help and clicking Send. A welcome message displays with setup instructions.
Start a conversation
Click the link to log in to your Workato account (opens new window) in the welcome message. If you don't have a Workato account, you can create a new account (opens new window).
Navigate to Workato to App Connections (opens new window) in the top navigation bar, select create a new connection, and search for Workbot for Microsoft Teams.
Click Connect and log in with your Microsoft credentials to authenticate and authorize Workbot.
Authorize Workbot
Click Yes when prompted to allow Workato to access your information. If you are a Global administrator, you can optionally Consent on behalf of your organization. This allows users to reconnect to Workato without administrator approval during reauthorization. Microsoft Teams app permission policies must allow the Workbot app for your user.
Global admin
You can now begin using your connection to build Workbot recipes. Refer to community recipes (opens new window) to help you get started.
# Your first Workbot recipe
This example uses the View open opportunities in Salesforce recipe.
Use recipe
Select Use this recipe to continue.
Select Link your account to connect to Workbot for Microsoft Teams.
Link your account
Log in using your Microsoft credentials.
Log in
If successful, you should see this screen:
Successfully linked
Select Link your account to connect to Salesforce.
Link your account
Log into your Salesforce account.
Log in to the app
If successful, you should see this screen:
Successfully linked to Teams
Click Next to test the recipe. After a few seconds, your recipe should be ready for use.
Recipe ready
Close the pop-up window, and select Start recipe.
Go to Microsoft Teams and send Workbot the view_opportunities command, or type help and choose View opportunities.
Example of a post reply listing open opportunities from Salesforce
# The help command
Run the help command to display a list of available Workbot commands. Your Workato account must meet the following conditions for the help command to work correctly.
- A Workbot for Microsoft Teams connection
- A recipe with the Workbot for Microsoft Teams
New commandtrigger - A recipe that has been started
Help command
# Adding Workbot to a team
Workbot can also be added to your teams. This way, anyone from the team can run Workbot commands by mentioning the bot, for example, @workbot help.
Mention Workbot
# How to add Workbot to a team
Complete the following steps to add Workbot to a team.
Open Microsoft Teams, select Apps from the left navigation bar, and search for Workbot.
Search for Workbot in App catalog
Select Workbot, click the arrow, and select Add to a team.
Add to team
Select your team from the drop-down menu and then select Set up.
Select your team
You and your team members can now run Workbot commands by mentioning the bot, for example, @workbot help.
# Additional info
Refer to our documentation for more information on how Workbot functions.
Last updated: 4/29/2024, 9:51:21 PM