Workflow
Microsoft Teams Notification
Overview
Project for use cases around Microsoft Teams using REST protocol
Workflows
Name | Overview |
---|---|
Send Notification - Microsoft - Teams - REST | Send notification on Microsoft teams using webhook key |
For further technical details on how to install and use this Workflow Project, please click the Technical Documentation tab.
Table of Contents
Getting Started
This section is helpful for deployments as it provides you with pertinent information on prerequisites and properties.
Helpful Background Information
Workflows often include logic that varies from business to business. As a result, we often find that our Workflow Projects are more useful as modular components that can be incorporated into a larger process. In addition, they often can add value as a learning tool on how we integrate with other systems and how we do things within the Itential Automation Platform.
While these can be utilized, you may find more value in using them as a starting point to build around.
Prerequisites
Itential Workflow Projects are built and tested on particular versions of IAP. In addition, Workflow Projects are often dependent on external systems and as such, these Workflow Projects will have dependencies on these other systems. This version of Microsoft - Teams - REST has been tested with:
- IAP 2023.2
External Dependencies
Name | OS Version | API Version |
---|---|---|
Microsoft Teams | v1.0 |
Adapters
Name | Version | Configuration Notes |
---|---|---|
adapter-msteams | ^0.6.0 |
How to Install
To install the Workflow Project:
- Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Supported IAP Versions section in order to install the Example Project.
- Import the Example Project in Admin Essentials.
Testing
Cypress is generally used to test all Itential Example Projects. While Cypress is an opensource tool, at Itential we have internal libraries that have been built around Cypress to allow us to test with a deployed IAP.
When certifying our Example Projects for a release of IAP we run these tests against the particular version of IAP and create a release branch in GitLab. If you do not see the Example Project available in your version of IAP please contact Itential.
While Itential tests this Example Project and its capabilities, it is often the case the customer environments offer their own unique circumstances. Therefore, it is our recommendation that you deploy this Example Project into a development/testing environment in which you can test the Example Project.
Using this Workflow Project
Workflow Projects contain 1 or more workflows. Each of these workflows have different inputs and outputs.
Send Notification - Microsoft - Teams - REST
Send notification on Microsoft teams using webhook key
Capabilities include:
- Send notification on Microsoft Teams using webhook key
Entry Point IAP Component
The primary IAP component to run Send Notification - Microsoft - Teams - REST is listed below:
IAP Component Name | IAP Component Type | Send Notification - Microsoft - Teams - REST | Workflow |
---|
Inputs
The following table lists the inputs for Send Notification - Microsoft - Teams - REST:
Name | Type | Required | Description | Example Value |
---|---|---|---|---|
text | string | yes | Notification text | Are you available for a call? |
title | string | yes | Notification title | Sync up |
webhookKey | string | yes | MS teams webhook key | webhookb2/16e71d2b-2b61-40d8-a163-a1c39aaff787@a8413c80-2495-4b90-a922-6e9ff2974531/IncomingWebhook/dd4f6837b7f84a38805428cd54bf81f4/cfacf732-5cfc2 |
adapterId | string | yes | Microsoft adapter instance name configured in IAP | MS Teams |
Outputs
The following table lists the outputs for Send Notification - Microsoft - Teams - REST:
Name | Type | Description | Example Value |
---|---|---|---|
result | object | Result has a key response which if equal to 1 means notification was sent successfully | 1 |
Query Output
The following items show how to query successful results from the output of Send Notification - Microsoft - Teams - REST:
response
result.response
The following items show how to query failure results from the output of Send Notification - Microsoft - Teams - REST:
errorMessage
errorMessage.IAPerror.raw_response.response
Example Inputs and Outputs
Example 1
Input:
{ "text": "World", "title": "Hello", "webhookKey":"webhookb2/16e71d2b-2b61-40d8-a163-a1c39aaff787@a8413c80-2495-4b90-a922-6e9ff2974531/IncomingWebhook/dd4f6837b7f84a38805428cd54bf81f4/cfacf732-fd60-4702-8026-8689c9b5cfc2", "adapterId": "MS Teams" }
Output:
{ "icode": "AD.200", "response": 1, "headers": { "content-length": "1", "content-type": "text/plain; charset=utf-8", "server": "Microsoft-IIS/10.0", "request-id": "2af9267d-63c1-d09d-4439-e06d066cfe97", "strict-transport-security": "max-age=31536000; includeSubDomains; preload", "alt-svc": "h3=\":443\",h3-29=\":443\"", "x-preferredroutingkeydiagnostics": "1", "x-calculatedfetarget": "CYXPR03CU003.internal.outlook.com", "x-backendhttpstatus": "200, 200", "x-calculatedbetarget": "CY4PR1801MB1864.NAMPRD18.PROD.OUTLOOK.COM", "x-end2endlatencyms": "2460", "x-rum-validated": "1", "x-rum-notupdatequeriedpath": "1", "x-rum-notupdatequerieddbcopy": "1", "x-proxy-routingcorrectness": "1", "x-proxy-backendserverstatus": "200", "x-bepartition": "CLNAMPRD18CYS01", "x-feproxyinfo": "BLAPR03CA0169.NAMPRD03.PROD.OUTLOOK.COM", "x-feefzinfo": "MNZ", "ms-cv": "fSb5KsFjndBEOeBtBmz+lw.1.1", "x-feserver": "CYXPR03CA0065, BLAPR03CA0169", "x-firsthopcafeefz": "MNZ", "x-powered-by": "ASP.NET", "date": "Fri, 04 Aug 2023 15:45:54 GMT", "connection": "close" }, "metrics": { "code": 200, "timeouts": 0, "redirects": 0, "retries": 0, "tripTime": 2578, "isThrottling": false, "capabilityTime": "2583ms" } }
API Links
No API Links provided.
Additional Information
Support
Please use your Itential Customer Success account if you need support when using this Workflow Project.