Teams Task Module

09/30/2025

Task Modules allow you to create modal popup experiences in your Teams bot or application. This sample shows how to fetch a Task Module from a Hero Card button and receive input from an Adaptive Card in the Task Module.

Interaction with bot

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app manifest (.zip file link below) to your teams and/or as a personal app. (Uploading must be enabled for your tenant, see steps here).

Teams Task Module: Manifest

Prerequisites

Microsoft Teams is installed and you have an account
Python SDK version 3.7
dev tunnel or ngrok latest version or equivalent tunnelling solution
Python SDK min version 3.11

Run the app (Using Microsoft 365 Agents Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Microsoft 365 Agents Toolkit for Visual Studio Code.

Ensure you have downloaded and installed Visual Studio Code
Install the Microsoft 365 Agents Toolkit extension and Python Extension
Select File > Open Folder in VS Code and choose this samples directory from the repo
Press CTRL+Shift+P to open the command box and enter Python: Create Environment to create and activate your desired virtual environment. Remember to select requirements.txt as dependencies to install when creating the virtual environment.
Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
Select Debug > Start Debugging or F5 to run the app in a Teams web client.
In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (uploading), Microsoft 365 Agents Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Run the app (Manually Uploading to Teams)

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

Register your app with Azure AD.

Register a new application in the Microsoft Entra ID – App Registrations portal.
Select New Registration and on the register an application page, set following values:
- Set name to your app name.
- Choose the supported account types (any account type will work)
- Leave Redirect URI empty.
- Choose Register.
On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You'll need those later when updating your Teams application manifest and in the appsettings.json.
Navigate to API Permissions, and make sure to add the follow permissions: Select Add a permission
- Select Add a permission
- Select Microsoft Graph -> Delegated permissions.
- User.Read (enabled by default)
- Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

Clone the repository

git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

Run ngrok - point to port 3978
```
ngrok http 3978 --host-header="localhost:3978"
```
Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:
```
devtunnel host -p 3978 --allow-anonymous
```
Create Bot Framework registration resource in Azure
- Use the current https URL you were given by running the tunneling application. Append with the path /api/messages used by this sample
- Ensure that you've enabled the Teams Channel
- If you don't have an Azure account you can use this Bot Framework registration
Bring up a terminal, navigate to Microsoft-Teams-Samples\samples\python\bot-task-module folder
Activate your desired virtual environment
Install dependencies by running pip install -r requirements.txt in the project folder.
Update the config.py configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)
Update CustomForm.html to replace your Microsoft App Id everywhere you see the place holder string {{AAD_APP_CLIENT_ID}}
This step is specific to Teams.
- Edit the manifest.json contained in the appManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string {{AAD_APP_CLIENT_ID}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json). Note: the Task Modules containing pages will require the deployed bot's domain in validDomains of the manifest.
- Zip up the contents of the appManifest folder to create a manifest.zip
- Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
Run your bot with python app.py

Running the sample

Note this manifest.json specified that the bot will be installed in "personal", "team" and "groupchat" scope which is why you immediately entered a one on one chat conversation with the bot. You can at mention the bot in a group chat or in a Channel in the Team you installed it in. Please refer to Teams documentation for more details.

You can interact with this bot by sending it a message. The bot will respond with a Hero Card with a button which will display a Task Module when clicked. The Task Module demonstrates retrieving input from a user through a Text Block and a Submit button.

Task Module running the sample

Task Module