Guides

Microsoft Teams

Suggest Edits

Prerequisites


Setting up the Microsoft Teams integration in Botpress

  1. Go to the Integration Hub in Botpress Cloud (if you don't have the integration installed yet).
  2. Find and open the Microsoft Teams integration then click on the "Install to Bot" button, now go back to your bot settings.

The Microsoft Teams integration has the following settings:

  • Enabled: Whether Botpress will communicate with Microsoft Teams
  • Webhook URL: The URL for receiving data in Botpress.
  • App Id: The App Id of your bot in Azure
  • App Password: The App Secret of your bot in Azure

Setting up Microsoft Teams

Register App

  1. In the Azure portal, open the App registrations page
  2. Click New registration, then choose a name for your application
  3. In the section Supported account types, choose the type that's most appropriate for your use case. We support Single and Multi Tenant accounts. Check out this article to learn more (in short, Single Tenant means the app will be available for your org only, and Multi Tenant will make it public). After selecting, click Register
  4. Copy paste the value of Application (client) ID to the App Id channel configuration in Botpress

App Password

  1. Find the Certificates & secrets page in the sidebar, click New client secret, then fill in the required fields
  2. Copy the value from the Value column and paste it in the App Secret channel configuration in Botpress
  3. Save the settings by clicking the "Save configuration" button

Create Your Microsoft Bot

  1. Navigate to the Bot Framework Creation page
  2. Fill the Display name and Bot handle fields with whatever value
  3. Copy paste you App Id to the app id field
  4. Copy the Webhook URL provided in Botpress to the Messaging endpoint field
  5. Choose a tenant for the App type. Follow the same type you chose in the Register App section
  6. Paste the App ID from the Azure bot in the Microsoft App ID field
  7. Read and agree to the terms then click Register
  8. On the next page (Connect to channels), under the section, Add a featured channel, click Configure Microsoft Teams Channel, then click Save

Accessing the Bot in MS Teams

  1. Navigate to the My Bots page
  2. Click on your bot's name
  3. Under the Connect to channels section, click on Microsoft Teams
  4. The bot should open in your MS Teams

That's it, you may now start chatting with your bot on Microsoft Teams!

📘

The bot will only be available to you if you have a Microsoft 365 Business account and if you are logged in to MS Teams with that account.

Making the bot available in your Organization

  1. Add the Developer Portal App to your Teams (or do it via the website)

  2. Click the Developer Portal App tab in the sidebar, then Apps. Now click the New app button

  3. In the left-side menu of the App, go to the App Features page under the Configure section then click "Bot"

  4. Select your existing bot from BotFramework in the dropdown. Check the desired scopes (at least Personal for 1:1 conversations)

  5. Fill out all the required fields in the Basic Information page of the Configure section

  6. Click Publish, then Publish to your Org

  7. Go to your Team App store, search for your app, then add it

  8. The bot is now available in the App section to all members of your organization!

📘

Info

In order to update your bot's behavior, just Publish the new version in Botpress. The changes will then be reflected in MS Teams, there's no need to change any settings in the Microsoft apps.

📘

Note

Botpress verifies the signature of the requests coming to the Webhook URL so that only Microsoft Teams can send data to your bot. Requests made from Postman or any other means will be rejected.


Setting up policies

If you're unable to send message to the bot (App), make sure you've enabled the policy to upload custom apps.
Go to Setup Policies -> Turn on Upload custom apps

Updated 5 months ago