Microsoft Teams steps
Flow Designer has built-in steps to help you integrate Microsoft Teams into your event management and incident response flows.
The following steps are available:
- Create Channel: create a new channel in Teams, using the inputs to construct the channel name and description, and to determine the team to create the channel in.
- Delete Channel: delete an xMatters generated channel in Teams, using the inputs to determine the channel to delete.
- Post Message: post a simple message to a channel, using HTML to format plain text, outputs from previous steps, or a combination of both.
- Post to Channel (Connector): post a message to a channel using a webhook connector you configure in Microsoft Teams. This allows you to post to the channel using a card format.
- Create Online Meeting: create a new instant meeting in Teams, using inputs to construct the meeting subject.
In the example above, the flow creates a ServiceNow incident based on a person's response to the alert notification. It then creates a Jira Cloud issue with information from the alert and the ServiceNow incident. A message is posted to a Teams channel, including information from the source system, the ServiceNow incident, and the Jira Cloud issue.
To use the Create Channel and Post Message steps, you need to create a Microsoft Graph API endpoint.
To use the Post to channel (Connector) step, you need to set up an incoming webhook connector in your Microsoft Teams channel, then create an endpoint that uses the unique URL generated when you set up the webhook connector. You can find details on setting up a webhook in the Microsoft Teams help.
Adding Microsoft Teams steps to your flow
- To add a Teams step to your flow, go to the Apps panel in the palette, expand the Microsoft Teams steps, and drag the step onto the canvas.
- Connect the step to the previous step in the flow so you have access to the alert properties and outputs of previous steps when configuring this step's inputs.
- Double-click the step to edit it, and use the Setup tab to configure the inputs. You can use plain text and input variables (or both). See the sections below for detailed information on the inputs for the step.
- On the Endpoint tab, configure the step to point to the appropriate endpoint:
- For Create Channel and Post Message, select a Microsoft Graph API endpoint.
- For Post to Channel (Connector), select the endpoint using the Teams webhook URL.
- For Create Meeting, select the Microsoft Graph API endpoint.
Create Channel
Use the Create Channel step to automatically create a new channel in a team, using text, constants, and the outputs from previous steps to populate the inputs.
Create Channel inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
Team* |
The team you want to create the channel in. You can identify the team by name or ID. |
|
Channel Name* displayName |
The name you want to give the newly created channel. |
|
Description description |
A brief description of the channel to help people identify its purpose. |
|
Continue if channel exists* |
Set what happens if a channel with the Channel Name already exists:
|
| Incident ID | Associates the channel with an incident in xMatters, adding it as a collaboration channel. For more information on adding collaboration channels, see the incident resolution workflow guide, or learn about incident management in xMatters. |
Outputs
|
Label API mapping |
Description |
|---|---|
|
Channel ID id |
The ID of the channel created. Example: You can use this output to populate the input of a "Post Message" step or in a step that adds a note to the system that kicked off the flow. |
|
Channel Name name |
The name of the channel created. Example: Like Channel ID, you can use this output to populate the input of a "Post Message" step or in a step that adds a note to the system that kicked off the flow. |
|
Channel URL webUrl |
A link to the channel. This is the same link you'd get if you click on the ••• beside the channel in Teams and selected Get link to channel. Examples: Include this in a field of a Create Alert step to add it to notifications, or add it as a note or update on the issue in your IT management application, such as Jira or Zendesk. |
Delete Channel
Use the Delete Channel step to automatically delete a channel created by xMatters in Teams, using text, constants, and the outputs from previous steps to populate the inputs.
Delete Channel inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
Team* |
Name or ID of the team the channel belongs to. |
|
Channel* |
Name or ID of the channel to delete. |
Outputs
|
Label |
Description |
|---|---|
|
Is Deleted |
If ‘true’, the channel was deleted. If ‘false’, the channel or team was not found, and the channel could not be deleted. |
Deleted channels in Microsoft Teams can be restored within 30 days. During this period, deleted channels continue to count toward your Microsoft Teams channel limits. For more information, see Limits and specifications for Microsoft Teams.
Post Message
Use the Post Message step to send a message to a channel in a team, using text, constants, and the outputs from previous steps to populate the inputs.
Post Message inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
Team* |
The name or ID of the team the channel belongs to. |
|
Channel* |
The name or ID of the channel where you want to send the message. |
|
Message* body.content |
The message you want to post to the channel. You can use basic HTML to format the message (for example, <b>, <i>, <a>, <ol>, <ul>, and <br>). |
|
Reply To ID replyToId |
The ID of the parent message or root message this message is a reply to. |
Outputs
|
Label API mapping |
Description |
|---|---|
|
Message ID id |
The ID of the message created. If this is a parent message, you can use this ID as the Reply To ID in another "Post Message" step. |
|
Channel ID |
The ID of the channel the message was added to. |
|
Team ID |
The ID of the team the message was added to. |
Post to Channel (Connector)
Use the Post to Channel step to automatically post a message to a channel in Microsoft Teams, using the input to populate the message.
To use this step, you need to set up an incoming webhook connector in your Microsoft Teams channel. You can find details in the Microsoft Teams help. Use the unique URL generated when you set up the connector as the Base URL when you configure an endpoint in xMatters.
Post to Channel inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label API mapping |
Description |
|---|---|
|
Message* text |
The text of the message you want to post to the Microsoft Teams channel. You can map alert information and outputs from previous steps of the flow to include them in the message that's posted. |
Create Online Meeting
Use the Create Online Meeting step to automatically create a new instant meeting, using text, constants, and the outputs from previous steps to populate the inputs. Outputs of this step include a URL users can click to join the meeting (instant meetings are not automatically added to the calendar), as well as dial-in information if audio conferencing is available for the meeting.
Create Online Meeting inputs and outputs
Inputs
Inputs with an asterisk* are required.
|
Label |
Description |
|---|---|
|
Subject* |
The subject or title you want to give to the newly created meeting. |
| Incident ID | Associates the meeting with an incident in xMatters, adding it as a collaboration channel. For more information on adding collaboration channels, see the incident resolution workflow guide, or learn about incident management in xMatters. |
Outputs
|
Label API mapping |
Description |
|---|---|
|
Meeting ID id |
The ID of the created meeting. Example: You can use this output to populate the input of a "Post Message" step or in a step that adds a note to the system that kicked off the flow. |
|
Join URL join_url |
A link to the meeting. Users can click this link to join the meeting. Examples: Include this in a field of a Create Alert step to add it to notifications, or add it as a note or update on the issue in your IT management application, such as Jira or Zendesk. |
|
Subject subject |
The subject or title of the created meeting. Example: Like Meeting ID, you can use this output to populate the input of a "Post Message" step or in a step that adds a note to the system that kicked off the flow. |
| Audio Conferencing Included |
Whether audio conferencing is available for the meeting (true or false). |
|
Toll-Free Number audioConferencing.tollFreeNumber
|
The primary toll-free number to dial into the meeting, if available. |
| Toll Number audioConferencing.tollNumber |
The primary toll number to dial into the meeting, if available. |
|
Conference ID audioConferencing.conferenceId |
The Conference ID of the meeting, if available. |
|
Dial-in Information URL audioConferencing.dialInUrl |
Link at which users can find dial-in information for the meeting, if available. |