Skip to content

Latest commit

 

History

History

csharp

README.md

page_type description products languages extensions urlFragment
sample
This sample demonstrates a Teams tab to send message cards using Incoming Webhook, showcasing the HttpPOST action for interactive cards.
office-teams
office
office-365
csharp
contentType createdDate
samples
04/01/2022 02:36:57 PM
officedev-microsoft-teams-samples-incoming-webhook-csharp

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.

Incoming webhook

This sample demonstrates a Teams tab where users can input Incoming Webhook URLs and send message cards to a specified Teams channel, illustrating the HttpPOST action for interactive message cards. It includes setup steps for running the sample, testing in multiple environments such as Outlook and Office, and provides insights into webhooks and connectors for extending Microsoft 365 apps.

Included Features

  • Tabs
  • Incoming Webhooks

Interaction with tab

webhook-tab

Prerequisites

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.

  1. Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
  2. Install Teams Toolkit for Visual Studio Teams Toolkit extension
  3. 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.
  4. In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
  5. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
  6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
  7. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
  8. 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

  1. Create a incoming webhook. Create incoming webhooks. Keep this webhook URL handy while running the sample.

2. Setup NGROK

  1. 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

  1. Clone the repository

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

  2. 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

  3. In a terminal, navigate to samples/incoming-webhook/csharp

    # change into project folder
cd # IncomingWebhook

  4. 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

  1. This step is specific to Teams.
    • Edit the manifest.json contained in the appPackage folder to replace {{Manifest-id}} with any GUID ID.
    • Edit the manifest.json for contentUrl, websiteUrl inside staticTabs section. Replace <<Domain-name>> with app's base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.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 the incoming-webhook\csharp\IncomingWebhook\Manifest_Hub folder with the required values.
    • Zip up the contents of the appPackage folder to create a Manifest.zip or Manifest_Hub folder to create a Manifest_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.

Running the sample

  • Open Incoming webhook tab. webhook-tab

  • Click on send button. You will get a card from webhook in the team where incoming webhook is added. webhook-tab

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

InstallOutlook

Select your app icon to launch and preview your app running in Outlook on the web

AppOutlook

InstallOutlookSend

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

InstallOffice

Select your app icon to launch your app in Office on the web

AppOffice

AppOffice

Note: Similarly, you can test your application in the Office 365 desktop app as well.

Further reading