Skip to content

Commit 2dbbd91

Browse files
Adding detailed setup instructions for configuring a Microsoft Teams bot. (#14932)
1 parent ba5a003 commit 2dbbd91

File tree

1 file changed

+127
-0
lines changed

1 file changed

+127
-0
lines changed
Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Overview
2+
3+
By connecting a Microsoft Teams Bot to Pipedream, you can build interactive chat experiences and automate messaging workflows using any of the thousands of apps available on Pipedream.
4+
5+
# Getting Started
6+
7+
To connect your Teams Bot to Pipedream, you'll need to create a bot in Azure, set up a webhook in Pipedream, and configure the Teams app manifest. Follow the detailed instructions below to get started.
8+
9+
## Configuring a Teams Bot in Azure Portal
10+
11+
To get started, you'll need the following:
12+
- An Azure account
13+
- A Microsoft Teams account
14+
- Basic familiarity with Azure Portal
15+
16+
## Quickstart
17+
18+
1. Create a bot in Azure Portal
19+
2. Set up a Pipedream webhook
20+
3. Configure the bot's messaging endpoint
21+
4. Create and upload the Teams app manifest
22+
5. Install the bot in Teams
23+
6. Configure your Pipedream workflow
24+
25+
For detailed instructions, follow the steps below.
26+
27+
## Detailed Setup Instructions
28+
29+
### 1. Create a Bot in Azure
30+
31+
1. Sign in to the [Azure Portal](https://portal.azure.com)
32+
2. Create a new "Azure Bot" resource
33+
3. During creation:
34+
- Select "Create new" Microsoft App ID
35+
- Note down the generated App ID (client_id)
36+
4. Navigate to the "Configuration" section
37+
5. Generate a new client secret
38+
6. Note down the secret value immediately (you won't be able to see it again)
39+
40+
### 2. Set Up Pipedream Webhook to receive bot messages
41+
42+
1. Go to Pipedream
43+
2. Create a new workflow starting with an HTTP trigger
44+
3. Copy the generated webhook URL (format: https://xxx.m.pipedream.net)
45+
- This will be your bot messaging endpoint
46+
47+
### 3. Configure Bot's Messaging Endpoint
48+
49+
1. Return to your Azure Bot resource
50+
2. Under "Configuration"
51+
3. Set Messaging endpoint to your Pipedream webhook URL
52+
53+
### 4. Create Teams App Manifest
54+
55+
1. Create a new file called `manifest.json` with the following template:
56+
57+
```json
58+
{
59+
"$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.14/MicrosoftTeams.schema.json",
60+
"manifestVersion": "1.14",
61+
"version": "1.0.0",
62+
"id": "<your-bot-app-id>",
63+
"packageName": "com.yourcompany.bot",
64+
"developer": {
65+
"name": "Your Company",
66+
"websiteUrl": "https://your-website.com",
67+
"privacyUrl": "https://your-website.com/privacy",
68+
"termsOfUseUrl": "https://your-website.com/terms"
69+
},
70+
"name": {
71+
"short": "Your Bot Name",
72+
"full": "Your Bot Full Name"
73+
},
74+
"description": {
75+
"short": "A brief description",
76+
"full": "A full description of your bot"
77+
},
78+
"icons": {
79+
"outline": "outline.png",
80+
"color": "color.png"
81+
},
82+
"accentColor": "#FFFFFF",
83+
"bots": [
84+
{
85+
"botId": "<your-bot-app-id>",
86+
"scopes": [
87+
"personal",
88+
"team",
89+
"groupchat"
90+
],
91+
"supportsFiles": false,
92+
"isNotificationOnly": false
93+
}
94+
],
95+
"permissions": [
96+
"messageTeamMembers"
97+
]
98+
}
99+
```
100+
101+
2. Create two icon files:
102+
- `outline.png` (32x32 pixels)
103+
- `color.png` (192x192 pixels)
104+
3. Zip these three files together
105+
106+
### 5. Install Bot in Teams
107+
108+
1. Open Microsoft Teams
109+
2. Go to Apps > Upload a custom app
110+
3. Upload your zip file
111+
4. Follow installation prompts, and your bot will now be added to Microsoft Teams!
112+
113+
### 6. Configure Pipedream Workflow
114+
115+
1. Add "Microsoft Teams Bot" app in Pipedream
116+
2. Enter your Bot's App ID and client secret
117+
3. Configure your workflow to process and respond to messages
118+
119+
# Troubleshooting
120+
121+
- **Authentication Issues**: Verify your App ID and client secret are correct
122+
- **Messaging Endpoint Errors**: Ensure your Pipedream webhook URL is properly configured in Azure
123+
- **Teams Installation Problems**: Check that your manifest.json and icon files meet all requirements
124+
125+
For more details, please see:
126+
* [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/)
127+
* [Teams App Manifest Documentation](https://docs.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema)

0 commit comments

Comments
 (0)