Skip to content

Latest commit

 

History

History
 
 

nodejs

README.md

page_type description products languages extensions urlFragment
sample
This is a sample app with capability to send notification when user creates a work item in [Azure DevOps](https://dev.azure.com) via webhooks.
office-teams
office
office-365
nodejs
javascript
contentType createdDate
samples
04/28/2022 12:00:00 AM
officedev-microsoft-teams-samples-bot-release-management-nodejs

Bot to create a group chat and send task notification using Azure webhooks.

This is a sample application which demonstrates how to create a webhook on Azure DevOps and connect with Teams bot that creates a group chat and send workitems details.

Key features

Workitem card

Prerequisites

  • Microsoft Teams is installed and you have an account (not a guest account)
  • NodeJS
  • ngrok or equivalent tunneling solution
  • M365 developer account or access to a Teams account with the appropriate permissions to install an app.
  • Azure DevOps access to set up service hooks and add custom field in workitem.
  • Teams Admin portal access to upload the manifest.json.

To try this sample

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

1. Start ngrok on localhost:3978

  • Open ngrok and run command ngrok http -host-header=rewrite 3978
  • Once started you should see URL https://41ed-abcd-e125.ngrok.io. Copy it, this is your baseUrl that will used as endpoint for Azure bot and webhook.

Ngrok

2. Setup Azure DevOps service hook.

3. Setup custom work item type.

Custom field

4. Register Azure AD application

Register one Azure AD application in your tenant's directory: for the bot and tab app authentication.

  • Log in to the Azure portal from your subscription, and go to the "App registrations" blade here. Ensure that you use a tenant where admin consent for API permissions can be provided.

  • Click on "New registration", and create an Azure AD application.

  • Name: The name of your Teams app - if you are following the template for a default deployment, we recommend "App catalog lifecycle".

  • Supported account types: Select "Accounts in any organizational directory"

  • Leave the "Redirect URL" field blank.

  • Click on the "Register" button.

  1. When the app is registered, you'll be taken to the app's "Overview" page. Copy the Application (client) ID; we will need it later. Verify that the "Supported account types" is set to Multiple organizations.

  • On the side rail in the Manage section, navigate to the "Certificates & secrets" section. In the Client secrets section, click on "+ New client secret". Add a description for the secret and select Expires as "Never". Click "Add".

  • Once the client secret is created, copy its Value, please take a note of the secret as it will be required later.

  • At this point you have 3 unique values:

    • Application (client) ID which will be later used during Azure bot creation
    • Client secret for the bot which will be later used during Azure bot creation
    • Directory (tenant) ID We recommend that you copy these values into a text file, using an application like Notepad. We will need these values later.

  • Under left menu, navigate to API Permissions, and make sure to add the following permissions of Microsoft Graph API > Application permissions:

    • Chat.Create
    • TeamsAppInstallation.ReadWriteForChat.All
    • AppCatalog.Read.All
    • User.Read.All

Click on Add Permissions to commit your changes.

  • If you are logged in as the Global Administrator, click on the Grant admin consent for %tenant-name% button to grant admin consent else, inform your admin to do the same through the portal or follow the steps provided here to create a link and send it to your admin for consent.

  • Global Administrator can grant consent using following link: https://login.microsoftonline.com/common/adminconsent?client_id=<%appId%>

5. Setup a Azure bot resource

  • Create new Azure Bot resource in Azure.
  • Select Type of App as "Multi Tenant"
  • Select Creation type as "Use existing app registration"
  • Use the copied App Id and Client secret from above step and fill in App Id and App secret respectively.
  • Click on Create on the Azure bot.
  • Go to the created resource, navigate to channels and add "Microsoft Teams".
  • Ensure that you've enabled the Teams Channel

6. Manually update the manifest.json

  • Edit the manifest.json contained in the /appPackage folder to and fill in MicrosoftAppId (that was created in step 1 and it is the same value of MicrosoftAppId as in .env file) everywhere you see the place holder string <<Microsoft-App-Id>> (depending on the scenario it may occur multiple times in the manifest.json)
  • Zip up the contents of the /appPackage folder to create a manifest.zip
  • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

7. Run your bot sample

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  2. In a terminal, navigate to samples/release-management/nodejs

  3. Install modules

    npm install

  4. Update the .env configuration for the bot to use the MicrosoftAppId and MicrosoftAppPassword and MicrosoftAppTenantId (Note that the MicrosoftAppId is the AppId created in step 4 , the MicrosoftAppPassword is referred to as the "client secret" in step 4 and you can always create a new client secret anytime., MicrosoftAppTenantId is reffered to as Directory tenant Id in step 4).

  5. Run your bot at the command line:

    npm start

NOTE: If you are not getting incoming request from Azure DevOps make sure that service webhook is in Enabled state.

Interacting with the bot.

  • Login into Azure DevOps and open the project where custom process was applied.
  • Create a new workitem -> Tasks, provide comma seprated email ids in StakeHolderTeam (NOTE: The email should belong to tenant where we register Application in step 4)
  • Save
  • Bot will create the group chat with members you added and send the Task details.