Skip to content

Latest commit

 

History

History
 
 
page_type description products languages extensions urlFragment
sample
This is an example to show how to write a connector for Microsoft Teams using GitHub's APIs.
office-teams
office-365
javascript
contentType technologies createdDate
samples
Connectors
08/21/2017 11:52:11 AM
officedev-microsoft-teams-samples-connector-github-notification-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.

GitHub Connector for Microsoft Teams

This is an example to show how to write a connector for Microsoft Teams using GitHub's APIs. It is not the source code for the GitHub connector in Teams/Outlook/Yammer.

Prerequisites

  1. Register a new OAuth application at GitHub. Note the GitHub client id and secret.
  2. If you want to run this code locally, use a tunnelling service like dev tunnel or ngrok latest version.
  3. If you are using Ngrok as a tunnelling service then download ngrok from https://ngrok.com/. Run the following command to setup a tunnel to localhost:3000 ngrok http 3000 Note the ngrok address, which looks something like https://013e0d3f.ngrok-free.app and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.
  4. Put the callback Url in the Oauth app as 'your-ngrok/auth/github/callback'.
  5. Replace the clientId,clientSecret,callbackUrl and serviceUrl in Default.json.

Configuration

  • Default configuration is in config\default.json

How to Run

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.