Documentation


Doc index page

Microsoft Teams notifications

Note

This document considers that the project is ready and that you successfully ran a first analysis on the code. If this is not the case yet, read the "Getting started" section.

Note

The notifications feature is only available on the Team plan. You can manage your current plan on your account page.

Now that the project is being analyzed (automatically or manually) by SymfonyInsight, you may like to receive notifications about the results of these analysis in your favorite messaging application.

Configure incoming WebHooks on your Teams

The first step to be notified by SymfonyInsight in Microsoft Teams is to configure Teams to receive incoming WebHooks.

To do so, go to teams.microsoft.com and click on the ... button next to the channel where you want the notifications and select "Connectors":

Choose a name and click on "Create".

This will give you a WebHook URL which should look like the following:

https://outlook.office.com/webhook/XXXXXXXXXX@XXXXXXXXX/IncomingWebhook/XXXXXXXXXXXXXX

Keep this URL close as you will need it to configure SymfonyInsight.

Add the notification configuration on SymfonyInsight

Notifications configuration can be put either in the .symfony.insight.yaml file or on the project edition page. While we usually recommend to put configuration in the file, notifications configuration can be sensitive as anyone having access to the WebHook URL can publish using it. It is therefore safer to put it in the SymfonyInsight Web interface, on the project edition page.

Note

You can learn more about how to configure SymfonyInsight on the dedicated documentation page.

Click on the "Edit project" link on the project page in SymfonyInsight and add the following lines in the "Advanced configuration" section:

1
2
3
4
5
6
7
8
9
notifications:
    - type: teams

      # The Teams WebHook URL you got in the previous step
      url: https://outlook.office.com/webhook/XXXXXXXXXX@XXXXXXXXX/IncomingWebhook/XXXXXXXXXXXXXX

      # On which event SymfonyInsight should post notifications
      on_success: true  # Notify when an analysis succeeded
      on_failure: true  # Notify when an analysis failed or errored

Once configured, you should see notifications appear in Teams.