# 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 need:

  • 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.
  • One of the following roles in your Microsoft organization:

    • 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

1

Sign in to your Workato account.

2

Navigate to Tools > Workbot.

3

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

4

In the Application field, select Workbot for Microsoft Teams.

5

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

6

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 App

2

On the Apps page, click + New app.

3

Fill in the following fields:

  • Short description
  • Long description
  • Developer info
  • App URLs
4

Fill in Application (client) ID (not to be confused with App ID) and click Save. This info be found in the Azure portal (opens new window) under App registrations > Your app > Overview.

5

Under Branding, set up the branding for the bot.

# Step 2.2: Create The Bot In Microsoft Teams

1

In your Microsoft Teams account, navigate to the Tools (opens new window) page.

2

Navigate to Bot management and click + New Bot.

3

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

4

Once the bot is created, 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 the setup in Workato.

5

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

6

Copy the secret and keep it handy - you'll need it to complete the setup in Workato.


# Step 3: Configure Workato To Talk To The App

1

Navigate back to the Workato page from Step 1.

2

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

Here's where they can be found in the Microsoft Teams Developer Portal (opens new window)

  • 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. Also located in Tools > Bot management > Your bot > Client secrets.
  • App ID: Located in Apps > Your app > Overview
3

Click Save.

4

Expand the Step 4 section and copy the bot endpoint address. It should look something like this:

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

Keep this handy - you'll need it to complete the next step.


# Step 4: Configure The App To Talk To Workato

# Step 4.1: Configure The Bot's Endpoint Address

1

Navigate back to the MS Teams Developer Portal.

2

Navigate to Tools > Bot management > Your bot > Configure.

3

Paste the bot endpoint address from the previous section.

4

Click Save.

# Step 4.2: Define Your Bot's Features

1

From the left navigation bar, navigate to Apps/Your app.

2

Under App features, click Bot.

3

Select your newly created bot from the dropdown menu.

4

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

5

Click Add a command.

6

Define the following:

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

Click Save.

# Step 4.3: Whitelist Workato's Domain

1

Navigate back to the Apps/Your app page.

2

Under Domains, click Add a domain and enter *.workato.com.

# Step 4.4: Configure Authentication Redirect URLs

2

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

3

On the page that displays, click on your bot.

4

From the left navigation bar, click Authentication.

5

Under Platform configurations, click +Add a platform/Web.

6

Enter the following redirect URI: #{Workato.site_url}/oauth/callback

7

Click Save, located near the top of the page.


# Step 5: Publish To Your Org

In the top navigation bar of your Azure portal, click Publish and select Publish to your org.