Planet eStream Support

Microsoft Teams App Setup Guide for Administrators

Introduction

The Planet eStream integration for Microsoft Teams allows users to create Virtual Classrooms, where students can view a live broadcast of the instructor and curated video content in real time, interacting with the class via a live comments panel. Users can also use webhooks to send links to Planet eStream content directly to other Teams from within the Planet eStream integration interface.

Please Note

  • The Microsoft Teams integration is only available for our cloud customers.
  • The Planet eStream Microsoft Teams App will require your system administrator to setup the Azure Graph API integration for your organisation – this integration enables end users to be fully authenticated. For guidance on setting up the Graph API please click here
  • If your Microsoft Teams is centrally managed system administrators may need to update the App Permissions Policy for Teams, for more information please see this Microsoft article: https://docs.microsoft.com/en-us/microsoftteams/teams-app-permission-policies

Setup

Within Azure

You will need to enable certain API permissions in your Azure app registration, in order for Planet eStream to read your list of Teams and send out links via webhooks. Please see the full list of required permissions below.

Within Planet eStream

Your Microsoft Teams integration licence has been automatically added to your Planet eStream subscription. As an admin user, go to Tools > Admin > Plugin Options and select Microsoft Teams from the drop-down list. Here, you will be provided with your unique access key. You will need this in order to set up the integration within Teams.

Below the access key, you will see a webhooks option, which will be covered in a section below.

Within Teams

You can find the integration in the Teams app store by searching for "Planet eStream". Select the integration and from "Add" drop down list, select Add to a Team, select the team you wish to add it to, and click Set Up.

Once that's done, you will see a window asking you to enter your Planet eStream URL (in the format https://mysite.planetestream.com) and access key, which you should have located previously. Enter these now and click Save. You can choose to post a message to the selected channel that informs the users about the installation, if you wish.

Important note: some Planet eStream cloud customers will be using their own custom website URL to access your Planet eStream website. Due to whitelisting of addresses by Microsoft, only *.planetestream.com addresses are whitelisted. To locate your planetestream.com address, navigate to a video and on the Share > Share By Embedding, locate the OneNote link. The start of this link will contain your planetestream.com address.

Setting Up a Webhook

To share links to Planet eStream content directly from within the Teams interface, you need to set up webhooks and assign them to each team. To add a webhook, as an administrator, click the ellipsis button (...) next to the team name and select Manage Team. Then click Apps > More Apps and search the store for "webhook". You should see the following result:

Add this connector to your team. You will be asked to provide a name, and if you like, image for the webhook. This can be the name and logo of your organisation, or you could simply name it "Planet eStream". Click Create and you will be provided with a webhook URL. Important: jot this down now! You will not be shown again and will have to re-add the webhook if you lose it.

Go to the Plugin Options page and Microsoft Teams tab in Planet eStream. Here, click Add New Webhook. You should see a drop-down list containing the available teams. Select the correct one and paste the webhook URL here, and click save.

Using Planet eStream in Teams

Webhooks

Once you have set up a webhook (see above), you can post a link card to teams directly from the integration UI. Go to the Planet eStream tab in your team and use the search bar to perform a search for the content you wish to share. If you like, you can click the play icon on the item's thumbnail to preview the item, and then press escape to close the preview window. Clicking the name of the item will show you a drop down list of all the teams you've configured webhooks for. Simply choose the correct team and press Send to Selected Team. You should receive a success notification if everything worked, and a link to the item in the form of a card will be sent to the chosen team.