Teams Message

The Teams Message Step Handler sends a WebHook message to a Teams channel, allowing you to post notification messages into Microsoft Teams.

Configuration

Example

We use the Teams Message Step Handler to send a message every time a new message arrives in our helpdesk system. Have a look at the steps below for more information on how to get started.

Get the Web Hook URL

To begin getting the web hook URL you will need to add Incoming Web Hooks to your channel apps. To do this go to the team you wish to add the message to and click ... for more options. Choose Manage Team and then open the Apps tab. From here go to the store and choose Incoming Webhook.

Now follow the steps to set up the incoming web hook: Choose the channel to install it to, type in a name for the web hook and then click Create.

Once you have created your Web Hook the URL will be displayed in the window like the screen capture below.

For more information on setting up Web Hooks in Microsoft Teams please visit their page here.

Configure the Ouvvi Step

Enter Teams Web Hook URL

You can enter the Teams Web Hook URL to Ouvvi as a User Setting, meaning that you will only have to type the user defined name rather than the whole URL.

If you have to use the URL again in other project, you can do so by using the user setting rather than typing the whole URL out.

If you use the URL in multiple projects and need to change it, by having the URL stored as a user setting you can edit it within the setting and update all of the projects that use that setting.

For more information on user settings please visit our User Setting page.

Enter Message

Now enter the message json you wish to post to your Teams Channel.

In the below example we are creating a Message Card style message and outputing the Project and Step details.

{
  "@type": "MessageCard",
  "@context": "http://schema.org/extensions",
  "summary": "{{STEPNAME}}",
  "themeColor": "0078D7",
  "title": "",
  "sections": [
    {
      "activityTitle": "{{STEPNAME}}",
      "activitySubtitle": "{{DATE}} {{TIME}}",
      "facts": [
        {
          "name": "Project:",
          "value": "{{PROJECTNAME}}"
        },
        {
          "name": "Instance #:",
          "value": "{{INSTANCEID}}"
        },
        {
          "name": "Status:",
          "value": "{{RUNNINGSTATUS}}"
        }
      ],
      "text": ""
    }
  ],
  "potentialAction": [
    {
      "@type": "OpenUri",
      "name": "View in Ouvvi",
      "targets": [
        {
          "os": "default",
          "uri": "{{ThisServiceEndpoint}}log/instance/{{INSTANCEID}}"
        }
      ]
    }
  ]
}

This will then send a message to your Teams channel that looks like this.