Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 3.39 KB

README.md

File metadata and controls

82 lines (58 loc) · 3.39 KB
Raw
page_type description products languages extensions contentType createdDate
sample
Samples to create "Custom Bots" to be used in Microsoft Teams.
office-teams
office
office-365
csharp
samples
07-07-2021 13:38:27

Outgoing Webhook

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.

Example screenshot to reply to any message: Basic response

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

Create an outgoing webhook

  1. Select the appropriate team and select Manage team from the (•••) drop-down menu.
  2. Choose the Apps tab from the navigation bar.
  3. From the window's lower right corner select Create an outgoing webhook.
  4. 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.
    • 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.

Pre-requisites

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

  • .NET Core SDK version 3.1

    # determine dotnet version
dotnet --version

  • ngrok or equivalent tunnelling solution

  • Visual Studio

  • Asp.net Core

To try this sample

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

  1. Clone the repository git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  2. 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 in AuthProvider.cs file.
    • Press F5 to run the project

  3. Run ngrok - point to port 3978

    ngrok http -host-header=rewrite 3978

  4. Run your solution from Visual Studio with F5.