Incoming webhook
Important
The existing Microsoft 365 (previously called Office 365) connectors across all cloud platforms are nearing deprecation, and the creation of new Microsoft 365 connectors will soon be blocked. For more information on the schedule and how the Workflows app provides a more flexible and secure experience, see retirement of Microsoft 365 connectors within Microsoft Teams.
This sample demos UI to type in Incoming Webhook URL and message card payload, which send the card in the team also demonstrates the HttpPOST action in the card.
Included Features
- Tabs
- Incoming Webhooks
Interaction with tab
Prerequisites
.NET Core SDK version 6.0
# determine dotnet version dotnet --version
Publicly addressable https url or tunnel such as dev tunnel or ngrok latest version or Tunnel Relay
Teams Microsoft Teams is installed and you have an account
Run the app (Using Teams Toolkit for Visual Studio)
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.
- Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
- Install Teams Toolkit for Visual Studio Teams Toolkit extension
- In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel.
- In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
- In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
- 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 menu in Visual Studio.
- 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 (sideloading), Teams 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.
Setup
1. Setup for incoming webhook
- Create a incoming webhook. Create incoming webhooks. Keep this webhook URL handy while running the sample.
2. Setup NGROK
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
3. Setup for code
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
In a terminal, navigate to
samples/incoming-webhook/csharp/ClientApp
npm install
If you face any dependency error while installing node modules, try using below command
npm install --legacy-peer-deps
In a terminal, navigate to
samples/incoming-webhook/csharp
# change into project folder cd # IncomingWebhook
Run the app from a terminal or from Visual Studio, choose option A or B.
A) From a terminal
# run the app
dotnet run
B) Or from Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
IncomingWebhook
folder - Select
IncomingWebhook.csproj
file - Press
F5
to run the project
4. Setup Manifest for Teams
- This step is specific to Teams.
- Edit the
manifest.json
contained in theappPackage
folder to replace{{Manifest-id}}
with anyGUID
ID. - Edit the
manifest.json
forcontentUrl
,websiteUrl
insidestaticTabs
section. Replace<<Domain-name>>
with app's base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.ngrok-free.app
and if you are using dev tunnels then your domain will be like:12345.devtunnels.ms
. - Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the
manifest.json
in theincoming-webhook\csharp\IncomingWebhook\Manifest_Hub
folder with the required values. - Zip up the contents of the
appPackage
folder to create aManifest.zip
orManifest_Hub
folder to create aManifest_Hub.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package) - Upload the
manifest.zip
to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.) - Add the app to personal scope.
- Edit the
Running the sample
Open Incoming webhook tab.
Click on send button. You will get a card from webhook in the team where incoming webhook is added.
Outlook on the web
To view your app in Outlook on the web.
Go to Outlook on the weband sign in using your dev tenant account.
On the side bar, select More Apps. Your sideloaded app title appears among your installed apps
Select your app icon to launch and preview your app running in Outlook on the web
Note: Similarly, you can test your application in the Outlook desktop app as well.
Office on the web
To preview your app running in Office on the web.
Log into office.com with test tenant credentials
Select the Apps icon on the side bar. Your sideloaded app title appears among your installed apps
Select your app icon to launch your app in Office on the web
Note: Similarly, you can test your application in the Office 365 desktop app as well.