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.

Prerequisites

Before configuring the Microsoft Teams integration, complete the general Microsoft integration setup. See Microsoft.

Configuration

warning

Complete the following steps in the order listed. Completing them out of order will cause the integration to not work correctly.

Creating bot resources in Azure:

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

   • Select Create new Microsoft App ID. You will retrieve the credentials for this auto-generated app in step 4.

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

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

4. Go to App registrations and copy and save the app ID (client ID) and tenant ID. The client secret auto-generated in step 1 cannot be retrieved later, so create a new client secret and save its value as well. You will need all three values to create an app in Brightspot in the following step.

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, sign in to Microsoft using an admin account to enable automated installation of the Brightspot Teams App.

5. Under App For Teams Bot, create a new Microsoft app:

   1. Click the selection field, then click Create New. A New Microsoft App content edit form appears.
   2. In the Name field, type a name for the app. This name is visible only in Brightspot.
   3. In the Client ID field, type the client ID saved in step 4 of "Creating bot resources in Azure" above.
   4. In the Client Secret field, type the client secret saved in step 4 of "Creating bot resources in Azure" above.
   5. In the Tenant ID field, type the tenant ID saved in step 4 of "Creating bot resources in Azure" above.
   6. Click Save.

6. Under Teams Bot URL, select a bot by pasting the address of the Open in Teams link that you copied in step 3 of "Creating bot resources in Azure" above.

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 "Notifications" 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 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.