Skip to main content

Microsoft Teams

The Microsoft Teams integration enables seamless collaboration between Brightspot and Microsoft Teams by allowing you to send notifications directly to Teams channels and individual users. This integration supports both system-wide and personal notifications, enabling Teams users to stay informed about content changes and system events without leaving their collaboration platform.

Adding a Microsoft app​

This section explains how to add a Microsoft Teams app in both the Microsoft identity platform and in Brightspot.

Note

Your Microsoft App may require you to define a Redirect URI in order to authenticate with a site. This URI is the domain name of your Brightspot site with cms/microsoft/auth appended onto it.

To add a Microsoft app:

  1. Register an application with the Microsoft identity platform, then copy the Client ID, Tenant ID, and Client Secret values. These values are needed to create a Microsoft app in Brightspot (described below) as well as to create an Azure Bot resource for the Microsoft Teams integration (described in the "Configuring Microsoft Teams" section below).

  2. Log in to Brightspot.

  3. Click > Admin > Sites & Settings > Sites > Global.

  4. From the Integrations tab, expand the Microsoft cluster.

  5. Under App, create a new Microsoft app by following the steps below:

    1. Click the selection field, then click Create New. A New Microsoft App content edit form appears.
    2. Under Name, enter a name for the Microsoft app. The name of this app is only visible in Brightspot and can be used internally to identify the Microsoft app.
    3. Under Client ID, enter the Microsoft Client ID copied from Microsoft in Step 1.
    4. Under Client Secret, enter the corresponding Microsoft Client Secret copied from Microsoft in Step 1.
    5. Under Tenant ID, enter the corresponding Microsoft Tenant ID copied from Microsoft in Step 1.
    6. Click Save.

  6. Click Save.

Configuration​

This topic explains how to configure Microsoft Teams both in Microsoft and then in Brightspot.

Creating bot resources in Azure:

  1. Register an application with the Microsoft identity platform.

    • The redirect URL should be https://<your-brightspot-cms-domain>/cms/microsoft/auth (for example, https://cms.brightspot.example.com/cms/microsoft/auth). Ensure that the URL is not protected by basic authentication.
    • For credentials, create a client secret and save it.
    • Copy and save the application's Client ID, Tenant ID, and Client Secret values, as you will need these values to create a Microsoft app in Brightspot.

  2. Create an Azure Bot resource via the Azure dashboard or Azure CLI.

    • If you created an app in the previous step, select Use existing app registration and enter your existing Client ID and Client Secret from the previous step.
    • If you did not create an app in the previous step, copy and save the application's Client ID, Tenant ID, and Client Secret, as you will need these values to create a Microsoft app in Brightspot.

  3. Navigate to the Configuration page and provide the following messaging endpoint: https://<your-brightspot-cms-domain>/microsoft/teams/api/messages (for example, https://www.cms.brightspot.example.com/microsoft/teams/api/messages). Ensure that the endpoint is not protected by basic authentication.

  4. Connect a bot to Microsoft Teams. Once connected, copy and save the address of the Open in Teams link under the Action column.

Configuring the app in Brightspot:

  1. Log in to Brightspot.

  2. Click > Admin > Sites & Settings > Sites > Global.

  3. From the Integrations tab, expand the Microsoft Teams cluster.

  4. Under Account for App Installation, click the button to be redirected to Microsoft to authenticate. You are redirected back to Brightspot after authentication, and you are prompted to save your settings to activate the admin account.

    Note

    Only Microsoft admins are able to authenticate this Microsoft account. If a user other than an admin attempts to authenticate, the attempt fails.

    Once a Microsoft admin authenticates with Microsoft, Brightspot associates the admin's account with the Brightspot user account. The Account for App Installation field in Brightspot then converts to a read-only field.

  5. Under App for Team Bot, click to search for an existing Microsoft app. If you have not yet created a Microsoft app in Brightspot, see the "Adding a Microsoft app" section above.

  6. Under Teams Bot URL, select a bot by pasting the address of the Open in Teams link that you copied in Step 4 of this topic.

  7. Toggle on Allow App Selection for Notification to allow editors to choose an app for notification in their profile. Enable this toggle in multi-tenant environments.

  8. Click Save.

Note

For additional information about configuring how end-users consent to applications in the Azure dashboard, or about configuring the Brightspot Teams App in Microsoft and the Azure dashboard, read below.

Configuring how end-users consent to applications in the Azure dashboard:

End users may not be able to grant permissions to the Brightspot app depending on the user consent settings in Azure. If users are required to submit an approval request to an admin when they sign in with Microsoft via Brightspot, you can configure how end-users consent to applications using Azure Active Directory. If you decide to allow users to consent for permission classified as low impact, add the following permissions: Channel.ReadBasic.All, Team.ReadBasic.All, offline_access, openid, profile, User.Read.

Uploading Brightspot Teams app to an organization's app store:

  1. Modify manifest.json by replacing [DOMAIN], [BOT_APP_ID], [PATH_TO_PRIVACY_POLICY_URL], [PATH_TO_TOU_URL] with proper values. For more information, see the manifest.json file. For more information, you can check the manifest.json references.
  2. Zip the files in the app directory (manifest.json, bsp-teams-icon-color.png, and bsp-teams-icon-outline.png) and upload the .zip to the organization's app store. You can also manage your apps in the Microsoft Teams admin center.
Note

Once the Microsoft Teams integration is configured, you can configure notifications. For details, see the "Configuring notifications with Microsoft Teams" section below.

Notifications​

Brightspot can send notifications to both individual users and channels within a Microsoft Teams team. To enable this feature, the Brightspot Teams app must be installed in your organization's app store. For details, see the "Uploading Brightspot Teams app to an organization's app store" section in the "Configuring Microsoft Teams" section above.

Note

If, for development purposes, the app is uploaded to your personal app store, ensure that you install it manually for both a team and a user.

To configure system notifications:

  1. Click > Admin > Sites & Settings > Sites > Global.
  2. From the CMS tab, expand the Notifications cluster.
  3. Under System Notifications, click Add System Notification.
  4. Under Delivery Methods, select Microsoft Teams.
  5. Under Team and Channel, select the team and channel to which notifications should be sent.
  6. Click Save.

To configure individual notifications:

  1. In the header, click your username > Profile.
  2. Expand the Notifications cluster.
  3. Under Delivery Methods, click Add, and select Microsoft Teams.
  4. Click Save.
Note

A user will be offered to select an app only in a multi-tenant environment.