csharp

page_type	description	products	languages	extensions	urlFragment
sample	This sample demonstrates how to implement a straightforward Outgoing Webhook for Microsoft Teams, allowing users to send messages to external services without the complexity of creating a full bot.	office-teams office office-365	csharp	contentType createdDate samples 07/07/2021 01:38:27 PM	officedev-microsoft-teams-samples-outgoing-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.

Outgoing Webhook Sample C#

The Outgoing Webhook Sample C# project illustrates how to create a basic Outgoing Webhook for Microsoft Teams, enabling seamless integration with external applications. This solution allows users to send messages to a specified callback URL and receive structured responses, streamlining interactions and enhancing functionality within Teams without the overhead of a complete bot framework.

Summary

Webhooks are a great way for Teams to integrate with external apps. A webhook is essentially a POST request sent to a callback URL. In Teams, outgoing webhooks provide a simple way to allow users to send messages to your web service without having to go through the full process of creating bots via the Microsoft Bot Framework. Outgoing webhooks post data from Teams to any chosen service capable of accepting a JSON payload. Once an outgoing webhook is added to a team, it acts like bot, listening in channels for messages using @mention, sending notifications to external web services, and responding with rich messages that can include cards and images.

Included Features

• Outgoing Webhooks

Interaction with app

Pre-requisites

• Microsoft Teams is installed and you have an account (not a guest account)

• .NET Core SDK version 6.0

  # determine dotnet version
  dotnet --version

• dev tunnel or ngrok latest version or equivalent tunnelling solution

• Visual Studio

• Asp.net Core

Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because

1. Create an outgoing webhook.

   • Select the appropriate team and select Manage team from the (•••) drop-down menu.
   • Choose the Apps tab from the navigation bar.
   • From the window's lower right corner select Create an outgoing webhook.
   • In the resulting popup window complete the required fields:
   • Name - The webhook title and @mention tap.
   • Callback URL - The HTTPS endpoint that accepts JSON payloads and will receive POST requests from Teams.
   • Test Scenarios 1 Callback URL should be like: <your_tunnel_URL>/api/Sample or yourappsiteurl/api/Sample
   • Test Scenarios 2 Callback URL should be like: <your_tunnel_URL>/api/authenticatedSample?id=contoso or yourappsiteurl/api/authenticatedSample?id=contoso
   • Description - A detailed string that will appear in the profile card and the team-level App dashboard.
   • Profile Picture (optional) an app icon for your webhook.
   • Select the Create button from lower right corner of the pop-up window and the outgoing webhook will be added to the current team's channels.
   • The next dialog window will display an Hash-based Message Authentication Code security token that will be used to authenticate calls between Teams and the designated outside service. This token in used in AuthProvider.cs.
   • If the URL is valid and the server and client authentication tokens are equal (i.e., an HMAC handshake), the outgoing webhook will be available to the team's users.

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. Clone the repository git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

4. If you are using Visual Studio

   • Launch Visual Studio
   • File -> Open -> Project/Solution
   • Navigate to samples/outgoing-webhook/csharp folder
   • Select WebhookSampleBot.sln file
   • Update the HMAC value for the Dictionary named SigningKeyDictionary in AuthProvider.cs file.
   • Press F5 to run the project

Running the sample

Example screenshot to reply to any message:

Example screenshot to show Hero card (using type of card in message):

Further Reading

Outgoing webhook