All Collections
Predefined Integrations
Microsoft Teams (via Microsoft Graph API) Overview
Microsoft Teams (via Microsoft Graph API) Overview

Learn more about our Microsoft Teams (via Microsoft Graph API) integration

Cutover Documentation Team avatar
Written by Cutover Documentation Team
Updated over a week ago

Microsoft Teams is used daily to collaborate and communicate across teams. The Cutover integration with Microsoft Teams requires access to the Microsoft Graph API. This provides the necessary information about teams and channels assigned to an MS Teams user, enabling dynamic search for a specific channel when setting up the integration in a Cutover runbook.

Note: Please also see our Microsoft Teams (via Microsoft Graph API authentication) technical guide. This can be found in the Integrations area of our Developer Portal.

In order to set up the integration, a user must first be authenticated with the Microsoft identity provider. Cutover has implemented this authentication following the OAuth2 authentication flow recommended by Microsoft for access to the Graph API, as described in this document.

Prerequisites


You should already be using Microsoft Teams within your organization and you must have authorized Cutover to access Microsoft Teams information. Assistance will be required by the Delivery team to set up the appropriate information for authentication with Microsoft. Some of the information included in this guide may have already been set up by the Delivery team, but it has been included for understanding.

To enable the Microsoft Teams integration, authorisation to the Cutover app (registered with Microsoft Azure) must be granted by your tenant organization. To find out more, a Microsoft tenant administrator should contact a Cutover Delivery Partner for an authentication link.

Using the integration


After your Microsoft Teams admin has authenticated, the Cutover Delivery team will set up the integration for you including how the authentication will work depending on whether this is an auto-start task or a manual task - see this section for further information. Once this has been done, the task type will be available in your Cutover runbook to use.

To get started, go to your workspace and create a new runbook. Create a task and click the Microsoft Teams task type.

When you have created the task you will need to authenticate in order to select the channel that the message should be delivered to. You can only view channels for which you have permission in MS Teams.

In the Task Edit panel of the selected Microsoft Teams task, scroll to the Microsoft Graph section of the task and add your message to be sent to Microsoft Teams as well as the channel your message is being sent to. Type in the channel name to display matches in a dropdown list.

Your integration is ready to be used. Put your runbook in live mode, start your run and begin the task to send the message to Microsoft Teams. Once you start the task and when the message is delivered, you will see a green notification saying “Message sent” on the right of the task during your live run.

In Microsoft teams you will be able to see the message, as well as a link to the corresponding runbook.

Task properties


When setting up an integration, further task property settings can be found within the Additional Settings area. Depending on which of the task settings are chosen when the integration is set up, the start of the integration is affected when the runbook is in live execution.

Auto start: Checking this confirms that the task will start automatically. The Microsoft Teams message is sent to the channel selected during the setup of the integration task. There is no manual input to start the task and the message will be posted from the person who selected the channel.

Manual start (if auto start is not selected): When auto start is not selected, the integration task must be started manually. The integration will be executed if the user who starts the task is the same as the one that selected the channel. If a different user starts the task, this user will need to authenticate with Microsoft.

The message will then be sent in the name of this user.

Important: If the user starting the task does not have the appropriate permissions to post in the channel, the integration will fail.

You can also view our enablement video on this integration here:

Did this answer your question?