| page_type | ssample | ||||
|---|---|---|---|---|---|
| description | This sample demonstrates sending message cards through Incoming Webhooks in Microsoft Teams and includes an HttpPOST action in the card. | ||||
| products |
|
||||
| languages |
|
||||
| extensions |
|
||||
| urlFragment | officedev-microsoft-teams-samples-incoming-webhook-nodejs |
Important
The existing Microsoft 365 (previously called Office 365) connectors across all cloud platforms are nearing deprecation, and the creation of new Microsoft 365 connectors will soon be blocked. For more information on the schedule and how the Workflows app provides a more flexible and secure experience, see retirement of Microsoft 365 connectors within Microsoft Teams.
This sample demonstrates how to use Incoming Webhooks in Microsoft Teams to send message cards. The UI allows users to input the Incoming Webhook URL and message card payload, which are sent to a team, showcasing the card's HttpPOST action for dynamic interaction. It includes setup instructions for tunneling solutions, API, and client app configuration, as well as integration across Microsoft 365 hubs like Outlook and Office.com.
- Tabs
- Incoming Webhooks
- NodeJS
- dev tunnel or ngrok latest version or equivalent tunnelling solution
- Teams Microsoft Teams is installed and you have an account
- Register a new application in the Microsoft Entra ID – App Registrations portal.
- Select New Registration and on the register an application page, set following values:
- Set name to your app name.
- Choose the supported account types (any account type will work)
- Leave Redirect URI empty.
- Choose Register.
- On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You'll need those later when updating your Teams application manifest and in the appsettings.json.
- Navigate to API Permissions, and make sure to add the follow permissions:
Select Add a permission
- Select Add a permission
- Select Microsoft Graph -> Delegated permissions.
User.Read(enabled by default)- Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
- Create a incoming webhook. Create incoming webhooks. Keep this webhook URL handy while running the sample.
-
Run ngrok - point to port 3978
ngrok http 3978 --host-header="localhost:3978"Alternatively, you can also use the
dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:devtunnel host -p 3978 --allow-anonymous
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
Install node modules
Inside node js folder, navigate to
samples/TeamsJS/incoming-webhoook/nodejs/apiopen your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.- Repeat the same step in folder
samples/TeamsJS/incoming-webhoook/nodejs/ClientApp
npm install
If you face any dependency error while installing node modules, try using below command
npm install --legacy-peer-deps
- Repeat the same step in folder
-
We have two different solutions to run so follow below steps:
A) In a terminal, navigate to
samples/TeamsJS/incoming-webhoook/nodejs/apiB) In a different terminal, navigate to
samples/TeamsJS/incoming-webhoook/nodejs/ClientApp -
Run both solutions i.e.
samples/TeamsJS/incoming-webhoook/nodejs/apiandsamples/TeamsJS/incoming-webhoook/nodejs/ClientAppnpm start
- This step is specific to Teams.
- Edit the
manifest.jsoncontained in theappManifestfolder to replace{{Manifest-id}}with anyGUIDID. - Edit the
manifest.jsonforcontentUrl,websiteUrlinsidestaticTabssection. Replace<<Domain-name>>with app's base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.appthen your domain-name will be1234.ngrok-free.appand if you are using dev tunnels then your domain will be like:12345.devtunnels.ms. - Edit the
manifest.jsonforvalidDomainswith base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.appthen your domain-name will be1234.ngrok-free.appand if you are using dev tunnels then your domain will be like:12345.devtunnels.ms. - Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the
manifest.jsonin theincoming-webhook\nodejs\appManifest_Hubfolder with the required values. - Zip up the contents of the
appManifestfolder to create aManifest.ziporappManifest_Hubfolder to create aappManifest_Hub.zip(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package) - Upload the
manifest.zipto Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.) - Add the app to personal scope.
- Edit the
-
To view your app in Outlook on the web.
-
Go to Outlook on the weband sign in using your dev tenant account.
On the side bar, select More Apps. Your uploaded app title appears among your installed apps
Select your app icon to launch and preview your app running in Outlook on the web
Note: Similarly, you can test your application in the Outlook desktop app as well.
-
To preview your app running in Office on the web.
-
Log into office.com with test tenant credentials
Select the Apps icon on the side bar. Your uploaded app title appears among your installed apps
Select your app icon to launch your app in Office on the web
Note: Similarly, you can test your application in the Office 365 desktop app as well.






