debian-mirror-gitlab/doc/user/project/integrations/microsoft_teams.md

62 lines
2.4 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
2022-11-25 23:54:43 +05:30
stage: Manage
2021-10-27 15:23:28 +05:30
group: Integrations
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-04-17 20:07:23 +05:30
# Microsoft Teams service **(FREE)**
2017-08-17 22:00:37 +05:30
2021-04-29 21:17:54 +05:30
You can integrate Microsoft Teams with GitLab, and display notifications about GitLab projects
in Microsoft Teams. To integrate the services, you must:
2017-08-17 22:00:37 +05:30
2021-04-29 21:17:54 +05:30
1. [Configure Microsoft Teams](#configure-microsoft-teams) to enable a webhook
to listen for changes.
1. [Configure your GitLab project](#configure-your-gitlab-project) to push notifications
to the Microsoft Teams webhook.
2021-02-22 17:27:13 +05:30
2021-04-29 21:17:54 +05:30
## Configure Microsoft Teams
To configure Microsoft Teams to listen for notifications from GitLab:
2021-12-11 22:18:48 +05:30
1. In Microsoft Teams, type `incoming webhook` in the search bar, and select
**Incoming Webhook**:
2021-02-22 17:27:13 +05:30
![Select Incoming Webhook](img/microsoft_teams_select_incoming_webhook.png)
2021-04-29 21:17:54 +05:30
1. Select **Add to a team**.
2021-02-22 17:27:13 +05:30
1. Select the team and channel you want to add the integration to.
1. Add a name for the webhook. The name is displayed next to every message that
comes in through the webhook.
2021-04-29 21:17:54 +05:30
1. Copy the webhook URL, as you need it to configure GitLab.
## Configure your GitLab project
After you configure Microsoft Teams to receive notifications, you must configure
GitLab to send the notifications:
2021-12-11 22:18:48 +05:30
1. Sign in to GitLab as an administrator.
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2021-12-11 22:18:48 +05:30
1. On the left sidebar, select **Settings > Integrations**.
1. Select **Microsoft Teams notifications**.
1. To enable the integration, select **Active**.
1. In the **Trigger** section, select the checkbox next to each event to enable it:
2021-04-29 21:17:54 +05:30
- Push
- Issue
- Confidential issue
- Merge request
- Note
- Confidential note
- Tag push
2021-12-11 22:18:48 +05:30
- Pipeline
2021-04-29 21:17:54 +05:30
- Wiki page
1. In **Webhook**, paste the URL you copied when you
[configured Microsoft Teams](#configure-microsoft-teams).
2021-12-11 22:18:48 +05:30
1. Optional. If you enable the pipeline trigger, select the
2021-10-27 15:23:28 +05:30
**Notify only broken pipelines** checkbox to push notifications only when pipelines break.
2021-04-29 21:17:54 +05:30
1. Select the branches you want to send notifications for.
2021-12-11 22:18:48 +05:30
1. Select **Save changes**.
2021-04-29 21:17:54 +05:30
2021-12-11 22:18:48 +05:30
## Related topics
2021-04-29 21:17:54 +05:30
2022-11-25 23:54:43 +05:30
- [Setting up an incoming webhook on Microsoft Teams](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#setting-up-a-custom-incoming-webhook).