What is Workbot for Microsoft Teams?
Workbot for Microsoft Teams is the Workato component that allows you to monitor and interact with your business apps from within Microsoft Teams. Workbot is powered by Workato recipes: a command that a user sends in Teams triggers a recipe, and the recipe replies in Teams.
A standard Workbot is a bot that you connect to Microsoft Teams using the Workbot app from the Microsoft Teams app catalog, without a custom OAuth profile. Workato supports only one standard Workbot per Microsoft Teams organization. An Enterprise Workbot is a Workbot that you connect through a custom OAuth profile, which lets you use your own Microsoft Teams app with your own name, logo, and permissions. It is required for running multiple Workbots in the same Microsoft Teams organization.
Before you open a ticket
First, check status.workato.com and status.cloud.microsoft for an ongoing incident. If there is one, follow its updates and check the affected functionality again once it is resolved.
The following actions often resolve the most common Workbot for Microsoft Teams issues, or help you work around them:
1. Check the recipe job
If Workbot replies with a recipe execution error, open the recipe that runs the command, find the failed job, and read the error. Fix the cause shown in the job and run the command again.
2. Check that Workbot can receive your command
- In a personal chat, send the command to Workbot directly. In a team channel, add Workbot to the team and mention it, for example
@workbot help. - Send
helpto Workbot. It lists the available commands. If no commands appear, check that the Workbot for Microsoft Teams connection is connected and that a recipe with the Workbot New command trigger is started. - Try the same command in a personal chat with Workbot. This shows whether the issue is specific to the team or channel.
If you use an Enterprise Workbot, type @ in the channel or chat and select Get bots to add your own bot.
3. Check the Microsoft Teams app policies
If Workbot is blocked for some users, or the installation and sign-in fail, ask your Microsoft Teams administrator to check that the Workbot app is not blocked and is allowed for the affected users. In the Teams admin center, check Teams apps > Manage apps, Permission policies, and Setup policies.
4. Check the connection and the Microsoft account
If the connection fails with an error such as Error on operation:team_info, exception: RestClient::InternalServerError, or if Workbot stops responding, check the following and reconnect the connection:
- Sign in with a work or school account. Personal Microsoft accounts are not supported.
- Confirm that the account has one of the roles required to install Workbot: Application administrator, Cloud application administrator, Global administrator, or Privileged role administrator.
- In the Advanced settings of the connection, remove API scopes that Workbot does not need.
- If your organization enforces multifactor authentication (MFA), complete the sign-in with MFA when you reconnect.
- If the error persists, confirm that your Microsoft organization allows third-party apps.
5. Check your Enterprise Workbot
If you use an Enterprise Workbot that cannot connect or has stopped responding, check the following:
Client secret. Client secrets of the Microsoft app expire periodically, typically after one year. In the Azure portal, open App registrations, select your bot, and check Certificates & secrets. If the secret has expired, create a new one and update it in your custom OAuth profile in Tools > Custom OAuth profiles.
Publish approval. Your Microsoft Teams administrator must approve the request to publish the app to your organization. Ask your administrator to confirm the approval status.
Bot endpoint address. In Workato, go to Platform > Workbot > Custom bots and copy the Bot endpoint address of your bot. In the Microsoft Teams Developer Portal, open Tools > Bot management, select your bot, and make sure the endpoint address is the same.
6. Check the installation
If you see the error “Bot already installed to the team”, another standard Workbot connection is already active in your Microsoft Teams organization. Find and disconnect the existing connection, then connect again, or use an Enterprise Workbot. If you are outside the USA, install the Workbot app for your region from the Microsoft Teams app catalog.
Information to include
If the issue persists, open a ticket and mention what you tried. Including the following information in your ticket helps Workato Product Support resolve it faster:
- Details of the issue
- Workbot details
- Microsoft Teams details
- Recipe ID and job ID (for recipe execution errors)
- Workspace ID
- Screenshots
How to collect it
Details of the issue
Describe the following:
- The exact command that you sent to Workbot.
- Detailed steps to reproduce the issue.
- What you expected to happen and what happened instead.
- The exact error message or Workbot reply, if any.
- Timestamp of the last occurrence, with time zone.
- How often the issue occurs.
- Whether the issue affects all users or only some of them.
- Any recent changes.
- Whether it worked before or is a new setup.
Workbot details
Include the following:
- The name of the Workbot for Microsoft Teams connection
- The type of Workbot: standard or Enterprise
- The name of the custom OAuth profile, if the connection uses one
- The Microsoft account that was used to create the connection
To find these values, open the connection in Connections. A connection with a custom OAuth profile selected is an Enterprise Workbot. The profile name is under Tools > Custom OAuth profiles.
Microsoft Teams details
Include the following:
- Where you talk to Workbot: a personal chat, a group chat, or a channel in a team
- Whether Workbot was added to that team or chat
- The Workbot app that you use: the default app or the app for your region
- The Microsoft Teams client: desktop, web, or mobile
Recipe ID and job ID
If Workbot replies with an error or does not reply:
- Open the recipe that runs the command.
- Copy the recipe ID from the browser address bar.
- Open the Jobs tab, open the failed job, and copy the job ID.
Workspace ID
Each environment (Development, Test, Production) has its own workspace ID. Provide the ID of the environment where the issue occurs. To find it:
- Open the environment where the issue occurs
- Navigate to Workspace Admin > Settings > General
- Copy the Workspace ID value
Screenshots
Screenshots of the following help Product Support investigate the issue:
- In the Microsoft Teams client, the conversation with Workbot that shows your command, the reply, and the time of the message
- In the Teams admin center, the Workbot app in Teams apps > Manage apps, showing its status
- In the Workato UI, the page where the issue occurs, captured as the full browser window, so that the error and the address bar are both visible
Do not include the client secret or any other credentials from the Azure portal or the Microsoft Teams Developer Portal.
Comments
0 comments
Please sign in to leave a comment.