Teams notification webhooks

John Reilly December 18, 2019
Source

Teams notifications are mighty useful. You can send them using Markdown via a webhook.

This post will explain the following:

  1. How you can automate the sending of notifications using Teams.
  2. How Teams supports Markdown in notifications.
  3. How you can use ASP.Net Core to automate sending notifications.

Notifications via Webhooks

Now, it's not obvious from Teams that there is a simple webhooks integration for Teams, but there is. It's tucked away under "Connectors". If you want to create a webhook of your own, find your team, your channel, click on the menu, then connectors and create a hook. Like so:

With the URL you've just obtained, you are now free to send notifications to that channel via a simple curl:

Markdown

Let's see if we can make this more interesting. It turns out that the the webhook can receive JSON as the body of the payload. And there's 3 properties we'd like our JSON to contain:

  1. title - this is optional and is the title of your notification if supplied.
  2. textFormat - provide the value "markdown" and then...
  3. text - provide your markdown notification content!

So if we have a notification payload file called down.json:

We can trigger it with this curl:

As you can see from the example above, you can use all the qualities of Markdown that you know and love. Text, bold text, italics, links and even images too. It's great!

ASP.Net Core

Finally, I wanted to illustrate just how simple the WebHooks API makes plugging notifications into an existing app. In our case we're going to use ASP.Net Core, but really there's nothing particular about how we're going to do this.

Here's a class called TeamsNotificationService. It exposes 2 methods:

  • SendNotification which allows the consumer to just provide a title and a message - you could consume this from anywhere in your app and use it to publish the notification of your choice.
  • SendExcitingNotification which actually uses SendNotification and illustrates how you might provide an exciting notification to publish out.

It's as simple as that ๐Ÿ˜„

Discussion in the ATmosphere

Loading comments...