Advanced Topics

# Creating a Microsoft Teams Enterprise Workbot

NOTE

This guide uses the Microsoft Teams Developer Portal (opens new window) to create and manage an app. As of January 1, 2022, Microsoft will be deprecating App Studio.

The approach outlined in this guide is the new, recommended method, but the App Studio instructions have been retained for reference.

Enterprise 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, such as:

Branding (bot name, bot logos, accent color)
Custom OAuth profile (bot ID, App secret)
Permissions

These Microsoft Teams apps can be sideloaded into your Microsoft Teams groups or channels for use by your members. If you want control over your bot's branding and permissions or multiple purpose-specific bots, Enterprise Workbots are for you.

# Setup requirements

To set up an Enterprise Bot, you must have the following:

In Workato:
- Access to:
  - Workbot. If you don't see the Tools > Workbot option in your account, contact your Customer Success Manager.
  - Custom OAuth profiles. If you don't see the Tools > Custom OAuth Profiles option in your account, contact your Customer Success Manager.
- Privileges that allow you to:
  - Create and configure Workbots.
  - Create and configure Custom OAuth Profiles.
In your Microsoft organization:
- One of the following roles:
  - Application administrator
  - Cloud application administrator
  - Global administrator
  - Privileged role administrator
Check your role assignments in Microsoft (opens new window) by navigating to Users > You (select your name) > Assigned roles.

# Step 1: Create the Workbot in Workato

Navigate to Tools > Workbot.

Click the Custom bot tab, then + New custom bot.

In the Application field, select Workbot for Microsoft Teams.

In the Name field, enter a name for the bot.

Click Create new app. You'll be redirected to the Microsoft Teams Developer Portal (opens new window).

Keep this page open - you'll need it to complete the setup for your bot.

# Step 2: Create a Microsoft Teams app

Step 2.1: Create the bot in Microsoft Teams Developer Portal
Step 2.2: Create the app
Step 2.3: Configure the bot permissions
Step 2.4: Configure authentication redirect URLs

# Step 2.1: Create the bot in the Microsoft Teams Developer Portal

Navigate to the Tools > Bot Management (opens new window) page.

Click + New Bot.

Enter a name for the bot and click +Add. We recommend using the same name as your app to avoid confusion.

Copy the Bot endpoint address from Step 4 of Workato's instructions. It should look something like this:

https://app.workato.com/skype_webhooks/event?coak_id=42

Click Save.

Copy the Bot ID from the page's URL. It will be similar to the following:

https://dev.teams.microsoft.com/bots/<YOUR-BOT-ID>/configure

Keep this info somewhere handy - you'll need it to complete further steps.

In the Client secrets section, click Add a client secret for your bot.

Copy the secret and keep it handy - you'll need it to complete the setup in Workato. Note that each secret is only shown once.

# Step 2.2: Create the app

On the Apps page, click + New app.

Fill in the following required fields:

Short description
Long description
Developer info
App URLs
Privacy policy
Terms of use

Under Basic Information, copy Bot ID from step 2.1 to Application (client) ID field.

Click Save.

Under Branding, set up the branding for the bot.

Under the Domains section of your app, click Add a domain and enter *.workato.com.

# Step 2.3: Configure the bot's permissions

Under App features, click Bot.

Select your newly created bot from the dropdown menu.

Under What can your bot do, check Upload and download files.

Select the scopes in which people can use this command: Check Personal, Team, and Group Chat.

Click Save.

Click Add a command.

Define the following:

Command: Enter help.
Description: Enter Type 'help' to view available commands.
Scopes: Check Personal, Team, and Group Chat.

Click Save again.

# Step 2.4: Configure authentication redirect URLs

Navigate to your Azure portal (opens new window).

In the search bar, enter App Registration and select the result.

On the page that displays, click on your bot.

From the left navigation bar, click Authentication.

Under Platform configurations, click +Add a platform and select Web.

Enter the redirect URI, depending on your data center:

US Data Center: https://www.workato.com/oauth/callback
EU Data Center: https://app.eu.workato.com/oauth/callback
JP Data Center: https://app.jp.workato.com/oauth/callback
SG Data Center: https://app.sg.workato.com/oauth/callback

Click Save, located near the top of the page.

# Step 3: Configure Workato to talk to the app

Navigate back to the Workato page from Step 1.

In the Step 3 section, fill in the following fields:

Bot ID: The Bot ID from the previous section. Also located in Tools > Bot management > Your bot.
Client secret: The client secret from the previous section.
App ID: Located in Apps > Your app > Basic Information.

Click Save.

# Step 4: Publish to your org

In the top navigation bar of your Azure portal, click Publish and select Publish to your org. Your Microsoft Teams admin will need to approve the publish request.

Last updated: 8/1/2023, 5:00:18 AM