Microsoft Teams (Edge)

Prerequisites

• An active Microsoft 365 tenant that uses Microsoft Teams, from which data is to be ingested.

• You are assigned the Application Developer or a higher role in Microsoft Entra ID to register an app.

• You are assigned the Privileged Role Administrator or Global Administrator role in Microsoft Entra ID to grant admin consent for the Microsoft Graph permissions.

Obtain the Microsoft Teams Credentials

Hevo connects to Microsoft Teams through an app registered in your Microsoft Entra ID tenant. The app reads data from Microsoft Graph using application permissions, so Hevo ingests the data of all the teams, users, chats, and calls in your tenant.

Register an app in Microsoft Entra ID

Perform the following steps to register an app and obtain its tenant ID and client ID:

1. Log in to the Microsoft Entra admin center.

2. In the left navigation pane, click Entra ID, and then click App registrations.

   

3. On the App registrations page, click + New registration.

   

4. On the Register an application page, do the following:

   1. Name: Specify a name for the app. For example, Hevo Microsoft Teams.

   2. Supported account types: Select Single tenant only - <Your Tenant Name>.

   3. Click Register.

   

5. On the Overview page of the app, copy the Application (client) ID and the Directory (tenant) ID, and save them securely like any other password. Use these values as the Client ID and Tenant ID while configuring your Microsoft Teams Source in Hevo.

   

Add the Microsoft Graph permissions

Perform the following steps to grant the app read access to your Microsoft Teams data:

1. On the page of the app that you registered, in the left navigation pane, click API permissions.

   

2. In the Configured permissions section, click + Add a permission.

   

3. In the Request API permissions pane, click Microsoft Graph.

   

4. Click Application permissions, search for and select the following permissions, and then click Add permissions:

   Permission	Objects
   AppCatalog.Read.All	teamsApps
   CallRecords.Read.All	call and its child objects, direct_routing_call, and pstn_call
   Channel.ReadBasic.All	channels, tabs, and channel_message and its child objects. Hevo also needs this permission to ingest the teams object.
   ChannelMessage.Read.All	channel_message and its child objects
   Chat.Read.All	chat and chat_message
   Team.ReadBasic.All	teams and its child objects, including channel_message and its child objects
   TeamMember.Read.All	members
   TeamsTab.Read.All	tabs
   TeamworkTag.Read.All	tags
   User.Read.All	users. Hevo also uses this permission to test the connection.

   

   Note: Grant the permissions of all the objects that you want to ingest. Hevo needs the User.Read.All permission to test the connection, and the Team.ReadBasic.All and Channel.ReadBasic.All permissions to ingest any object of the teams group. If a permission is missing, the Pipeline fails to ingest the related objects and the other objects ingested along with them. For example, if the permission of the members, tags, or tabs object is missing, Hevo does not ingest the teams object, its child objects, and the channel_message object and its child objects. If you do not grant the permission of an object, deselect that object while creating the Pipeline.

5. Click Grant admin consent for <Your Tenant Name>, and then click Yes to confirm.

   

Create a client secret

Perform the following steps to create a client secret for the app:

1. On the page of the app that you registered, in the left navigation pane, click Certificates & secrets.

   

2. On the Client secrets tab, click + New client secret.

   

3. In the Add a client secret pane, do the following:

   1. Description: Specify a description for the secret. For example, Hevo Pipeline.

   2. Expires: Select the period after which the secret expires.

   3. Click Add.

   

4. In the Value column of the secret that you created, click the copy icon, and save the value securely like any other password. Use this value as the Client Secret while configuring your Microsoft Teams Source in Hevo.

   

   Note: Microsoft Entra ID displays the secret value only once. Copy the value and not the secret ID.

If the client secret expires or is deleted from your app, Hevo cannot connect to Microsoft Teams, and the Pipeline fails. To resume data replication, create a new client secret and modify the Source configuration in the Pipeline to use it.