Configuring Microsoft Teams Integration notifications

2 minute read
CloudBees Microsoft Teams Integration is a Preview feature.
Preview

A Preview feature:

  • Has not undergone end-to-end testing with CloudBees products

  • Is provided without service-level agreements (SLA) and therefore does not include CloudBees' commitment on functionality or performance

  • May impact other stable areas of the product when used

  • May have limited documentation

  • May not be feature complete during the Preview period

  • May graduate from preview state to fully supported or be removed from the product

  • May introduce incompatible, backward-breaking changes that could revoke the ability to upgrade

Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support.

Users have two options for configuring Microsoft Teams Integration notifications:

  1. Enabling user notifications

  2. Opting out of notifications

Enabling user notifications

The CloudBees Microsoft Teams Integration Plugin sends notifications dynamically to Microsoft Teams when certain events are triggered that are associated with a build. These notifications can be sent to the linked Microsoft Teams channel when the GitHub pull request (PR) author matches the user in the plugin.

To send notifications when a GitHub PR author matches a user in the plugin, users must enable the plugin by providing the following information:

  • Teams Channel Webhook: The Microsoft Teams Webhook code that is provided when you set up the Connection to create a webhook.

  • GitHub Username: When a PR is built, if the GitHub author matches the user in the plugin, the CloudBees Microsoft Teams Integration Plugin sends a notification to the linked Microsoft Teams channel.

To enable CloudBees Microsoft Teams Integration notifications:
  1. From CloudBees CI, navigate to your user profile.

  2. Select MS Teams Integration.

  3. Enter the Microsoft Teams Channel Webhook URL that is provided when you or your administrator set up the Connection to create a webhook to CloudBees CI.

    See Setting up a custom incoming webhook in Microsoft Teams for how to set up the Connection to create a webhook to CloudBees CI.
  4. Enter your GitHub username for the GitHub account you will be using to create builds to this CloudBees CI controller.

  5. Select the Receiving Notifications toggle.

  6. Select Save.

Opting out of notifications

Some users may not want to receive notifications. These users can opt out by navigating to their user profile in CloudBees CI, selecting MS Teams Integration, deselecting the Receiving Notifications toggle, and selecting Save.