​
Setup Guide

You can find your Microsoft Teams application credentials by visiting the Microsoft Developer Portal for Teams.

You’ll need the following information to set up your Microsoft Teams app with Paragon Connect:

  • App ID
  • Bot ID
  • Bot Client Secret
  • Scopes Requested

​
Prerequisites

​
Creating a Microsoft Teams bot

You will need to create a bot user in the Microsoft Developer Portal for Teams to build your integration.

  1. Log in to the Developer Portal for Teams using the same Microsoft account that you use to log in to the Microsoft Azure Portal.

  2. Navigate to Tools in the sidebar.

  3. Select Bot Management.

  4. Click New Bot and provide a name for your bot. This is not the name that appears to your users; we recommend appending “(Bot)” to the name for clarity.

Next, you will need to associate this new bot with your Teams application.

  1. In the Developer Portal for Teams, navigate to Apps in the sidebar.

  2. If you do not have a Teams app yet, click New app and provide a name. This name will be the one displayed in the Microsoft Teams store and to your users.

    1. In Basic information, you will need to minimally provide a short description and URLs for your application’s website, Privacy Policy, and Terms of Use.

    2. Click Save below.

  3. In your Teams app settings, navigate to App features (under the Configure section).

  4. Select Bot.

  5. Select the bot user you created above.

  6. Check any applicable capabilities for your bot user.

  7. Click Save below.

  8. Optionally, upload an icon for your app in Branding.

​
Testing your Microsoft Teams bot

If your application is not yet published to the Microsoft Teams store, you can test your app by uploading your app’s package directly into your Teams account.

  1. In the Developer Portal for Teams, navigate to your list of Apps.

  2. Click the triple-dot menu in your app’s row and click Download app package. Your app’s package will be downloaded as a .zip file.

  1. Log in to Microsoft Teams with the account you would like to test your bot in.

  2. Click Apps in the left sidebar (one of the last options):

  1. Click Manage your apps (at the bottom of the App categories sidebar).

  2. Click Upload an app and Upload your app to your org’s app catalog.

  3. Select the .zip file with your app’s package. After a successful upload, you will be navigated to the “Built for your org” page.

  4. Select the name of your app in the list.

  5. Click Add and Add to a team.

  1. Select a team and channel to add your bot.

​
Add the Redirect URL to your Microsoft Teams app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Microsoft Teams app:

  1. Copy the link under “Redirect URL” in your integration settings in Paragon. The Redirect URL is https://passport.useparagon.com/oauth

  2. Log in to the Microsoft Azure Portal using your Microsoft account.

  3. Navigate to All Services > App Registrations and select the app registration representing your bot, not your Microsoft Teams app. You can check to make sure that the ID matches the one you selected for your associated bot: In Developer Portal for Teams > [Your App] > App Features:

  1. Select Authentication from the sidebar.

  2. Under Platform configurations, press the “Add a platform” button.

  3. Select the Web platform.

  4. Paste the Redirect URL from Step 1 under Redirect URIs.

  5. Press the Save button at the top of the page.

​
Generate a Bot Client Secret

Since Microsoft Teams does not automatically provide you with a Bot Client Secret for your application, we’ll need to make one. To get your Bot Client Secret:

  1. Navigate to All Services > App Registrations and select the app registration representing your bot, not your Microsoft Teams app. You can check to make sure that the ID matches the one you selected for your associated bot: In Developer Portal for Teams > [Your App] > App Features: In Azure Portal > App Registrations:

  2. Navigate to Manage > Certificates & secrets in the sidebar.

  3. Under Client Secrets, click the + New client secret button.

  4. Name your client credentials and select an expiry that works best for your application. Press Add to create your credentials.

  5. Copy the displayed Bot Client Secret under the Value column.

Note: You will need to periodically create new and update your Bot Client Secret as they expire for all Microsoft integrations.

​
Add your Microsoft Teams app to Paragon

  1. Select Microsoft Teams from the Integrations Catalog.

  2. Under Integrations > Connected Integrations > Microsoft Teams > Settings, fill out your credentials from the end of Step 1 and Step 2 in their respective sections:

  • App/Manifest ID: Found in the Microsoft Developer Portal for Teams, as the App ID:

  • Bot ID: Found in the Microsoft Azure Portal, under App registrations > Application (client) ID. This should be the Client ID of the app registration representing your bot, not your Microsoft Teams app.

  • Bot Client Secret: See Generate a Bot Client Secret.

  • Permissions: Select the scopes you’ve requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. View dashboard.

Press the blue “Connect” button to save your credentials.

Note: You should only add the scopes you’ve requested in your application page to Paragon.

​
Connecting to Microsoft Teams

Once your users have connected their Microsoft Teams account, you can use the Paragon SDK to access the Microsoft Teams API on behalf of connected users.

See the Microsoft Teams REST API documentation for their full API reference.

Any Microsoft Teams API endpoints can be accessed with the Paragon SDK as shown in this example.

// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List Channels
paragon.request("microsoftTeams", "channels", {
  method: "GET",
});


// Send message in a channel
paragon.request("microsoftTeams", "channels/<channel-id>/messages", {
  method: "POST",
  body: { "content": "Hello World!" }
});

​
Building Microsoft Teams workflows

Once your Microsoft Teams account is connected, you can add steps to perform the following actions:

  • Send message in channel
  • Send message in chat
  • Get User by email

When creating messages in Microsoft Teams, you can reference data from previous steps by typing {{ to invoke the variable menu.

​
Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users’ Microsoft Teams account. For example, you might want to trigger a workflow whenever new chats are created in Microsoft Teams to sync your users’ Microsoft Teams chats to your application in real-time.

You can find the full list of Webhook Triggers for Microsoft Teams below:

  • Channel Created
  • Chat Created
  • Chat Updated