To set up PlatformX for MS Teams, you need a bot to from which to send surveys with.
There are two options for configuring a bot in DX:
Using the Zephyr bot provided by DX
Creating custom bot(s)
Using the DX-provided bot is a great way to get started with PlatformX quickly. For long-term use, it is recommended that you create custom bots in order to fully customize the survey experience.
For either experience, installing the DX app (for surveys) to the team in Microsoft Teams as users are only provisioned through installation of the DX app. Users will not be able to receive PlatformX survey if they are not provisioned in DX.
Using the DX-provided bot
Step 1
Sign in to DX and browse to Administration > Teams bots. Click on the download icon for the Zephyr Bot to download the manifest ZIP file.
Step 2
Within Microsoft Teams, have an admin go to Manage Apps and click on the Upload new app button in the top right corner then upload the ZIP file.
Step 3
Install the app to team(s) within Microsoft Teams. The team(s) should be the same one(s) that the main DX app is installed to and contain all potential survey subjects as members (you will only be able to send surveys to users who are members of the teams the app is installed to.).
If you are using App Centric Management, make sure that the app is available to Everyone or Specified users and groups that includes the teams you are installing it for
Creating a custom bot
Register your app
Create an app registration within Microsoft Entra ID by visiting the App registrations page in the main navigation:
Click New registration and then type a name you'd like for your app. Then, select Multitenant and hit Register.
Create your app
Next, create a Teams app by browsing to the Microsoft Teams Developer Portal and click on the + New app button.
Fill out all required fields denoted by an asterisk.
For website URL, use https://app.getdx.com.
For privacy policy URL, use https://getdx.com/privacy
For terms URL, use https://getdx.com/terms.
When you get to the Application (Client) ID field, paste in the Application ID from the Entra app registration you created earlier:
Be sure to scroll to the bottom and hit Save. Then, after you've saved the Basic information, navigate to App features in the main navigation and click on the tile titled Bot to configure a bot for your app.
Under the Identify your bot field, select Select an existing bot and then click Create a new bot.
On the next screen, give your bot a name. The name you choose will be what your respondents will see in Teams in a conversation.
After you've specified a name, configure the endpoint address with https:/app.getdx.com/microsoft/interaction and Save.
Export the app
Select Client secrets in the sidebar navigation and click Generate a new secret. Store the secret on a document on your machine for access later. Then, navigate back to Apps on the left and click on the teams app you started creating.
Select App features again and click on Bot again.
From the dropdown, select an existing bot and pick the one you just created.
In the What can your bot do section, select Only send notifications (one-way conversations).
In the Select the scopes where people can use your bot section, select Personal and Team.
Then, hit Save.
Next, click on the Permissions link in the left-hand navigation and then check the box for Send the user notifications.
Expand the Application permissions and check the TeamMember.Read.Group permission.
Scroll to the bottom and hit Save.
At this point your app is ready to export. Be sure to add an icon from the Branding settings before exporting:
To export the app, select App package in the left-hand navigation and then click on the Manifest link.
The manifest.json file should look very similar to this, but with different IDs for the "id" and "botId"
{
"$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.17/MicrosoftTeams.schema.json",
"version": "1.0.0",
"manifestVersion": "1.17",
"id": "60711477-760f-4a73-8d23-c37d97bf8dff",
"name": {
"short": "Gen AI Feedback for Teams",
"full": ""
},
"developer": {
"name": "DX",
"mpnId": "",
"websiteUrl": "https://app.getdx.com",
"privacyUrl": "https://getdx.com/privacy",
"termsOfUseUrl": "https://getdx.com/terms"
},
"description": {
"short": "App to gather feedback from developers",
"full": "App using DX to gather feedback on internal tools for the platform team."
},
"icons": {
"outline": "outline.png",
"color": "color.png"
},
"accentColor": "#FFFFFF",
"staticTabs": [
{
"entityId": "conversations",
"scopes": [
"personal"
]
},
{
"entityId": "about",
"scopes": [
"personal"
]
}
],
"bots": [
{
"botId": "740c690a-334e-4a98-a33d-3c1f918205c0",
"scopes": [
"team",
"personal"
],
"isNotificationOnly": true,
"supportsCalling": false,
"supportsVideo": false,
"supportsFiles": false
}
],
"validDomains": [],
"webApplicationInfo": {
"id": "4eaf04ec-852c-40a6-b3d5-e227a453b64e",
"resource": ""
}
}
Hit Download app package in the top nav. You should get a zip file that consists of the manifest and branding (three files).
Add the bot in DX
Browse to Administration > Teams bots and click the + Add button.
Input the name of your Bot (not your teams app). This must match the name exactly of what you created earlier.
Paste in the application ID of the Bot. This can also be seen as the "botId" in the manifest.
Paste in the client secret for the bot that you stored earlier.
Then, hit Save.
Make your bot multi-tenant
Within Microsoft Entra ID, navigate to your bot and click on where it says My organization only under Supported account types.
Change this to Accounts in any organizational directory and hit Save.
Install your app to a team
Within Microsoft Teams, navigate to the team(s) you'd like to install the app to. The team(s) should be the same one(s) that the main DX app is installed to and contain all potential survey subjects as members (you will only be able to send surveys to users who are members of the teams the app is installed to.).
Right click on a team and select Manage team.
Go to Apps in the menu and click Upload an app. If this menu does not show, contact an IT admin to have them install it to the team.
Select your zip file, select Add, then Set up a bot.
You should get a message that lets you know the bot is successfully installed.
