You can now receive Zoom notifications and messages related to changes in your GitHub repositories from a chatbot by integrating GitHub notifications into Zoom.
Prerequisites for Zoom’s GitHub integration
- An account on GitHub
- Zoom App Marketplace has pre-approved the GitHub Chat Chatbot in their App Marketplace
Note: Please contact your Zoom administrator if the app has not been pre-approved.
How to install and configure GitHub Notifications
Install from the Zoom App Marketplace
- You will need to sign in with your Zoom account to access the Zoom App Marketplace.
- The app can be found by entering GitHub in the search box located in the top right corner of your screen.
- Click on the GitHub app from the results that appear in the search results.
Note:To approve this app for you, you will need to contact your Zoom admin to get this app approved for your account, if it is not already approved.
- Click the Add button.
- Ensure the app has the permissions it needs, then click Allow.
Note:It will automatically be installed for you in the Zoom desktop client if your admin has installed the GitHub app on the server.
Configure the GitHub subscription
In order to subscribe to the GitHub repository, you will be redirected to the GitHub Add Subscription page following the installation from the Zoom App Marketplace.
- Make sure your GitHub account is authenticated.
- To continue, simply click Authenticate.
In order to complete the authentication process and authorize Zoom, you will be taken to GitHub. Once you have completed the authentication process, you will be directed back to the subscription configuration page.
How to use the GitHub Chatbot
Add a subscription
If you wish to subscribe to a repository on GitHub, you must be an admin of that repository.
- As soon as you have authenticated your GitHub account, click Add a Subscription.
- Once you have completed the Basic Configuration page, click Save.
- Give the subscription a name and click Save.
- Next, select the channel where you want your notifications to come from.
- Then write a description for your subscription.
- You’re now ready to configure your GitHub account.
- Navigate to your repository and select the project(s).
- Using the check boxes provided, you can select which Events you would like to be notified about.
You will begin receiving notifications when you have configured your Zoom Chat subscriptions according to the settings you set for each subscription once this has been done.
Interact with the GitHub Chatbot
Once your subscription has been added, you will begin to receive chat notifications in the Zoom chat channel that you have configured.
You can type help to get a list of all commands available to you.
Connect a GitHub repository or branch by typing in the connect command.
As these commands are entered into the channel you are currently viewing, you will be added as a subscriber to that channel. First, you must connect your GitHub account to your repository before you can connect your repositories.
The next time you connect to the website, a message will appear that explains the correct syntax.
It is possible to connect both the repository and its branches, but only the repository will be displayed and the branches will not be displayed. The branches of the repository you are planning to connect can only be connected within the channel that is connected to this repository. This repository or any other branches of this repository can not be connected in this channel.
Adding a comment to an issue is as simple as typing it. This will be done by using the syntax comment [Shift+Enter] <comment>
You will need to do the following:
- The issue ID must be specified along with the full repository name.
- You can start a new line by pressing Shift + Enter.
- Feel free to leave a comment.
Type disconnect in the GitHub account field to disconnect your GitHub account.
It is only possible to disconnect the owner’s connections in the current channel with the disconnect command. If you want to disconnect a repository or branch, you must use the exact same name, for example, you cannot use disconnect owner/repository to disconnect owner/repository:branch
How to remove the GitHub Chatbot
- With your Zoom account, you will be able to access the Zoom App Marketplace.
- To gain access, click Manage in the top right corner of the page.
- Select Added Apps from the navigation menu to access the app.
- Then, click Remove next to the Github app.
- Confirm the dialog box and click Remove.
- Using this app, you will be able to access the following Zoom information:
- Using your Zoom account, you can view all of the groups that a Zoom user is a member of.
- In your Zoom account, you can view the details of existing meetings for a Zoom user.
- In the Zoom account, you can view the information regarding a Zoom user.
- In order to access Github, the application must have access to the following information:
- Information about your tickets, agents, and customers.
- Customer and agent information will be read-only on our side.
- Closing tickets will be the only permission we need to write on our side.
- Information about your tickets, agents, and customers.
- The Zoom chat app requires the following permissions to work:
- With the Zoom chat app, one can chat with an IM channel or a user under their Zoom account in order to send a message.
- Any Zoom user under a Zoom account can use the Zoom chat app to start a Zoom meeting on behalf of themselves.
- All communication between Zoom/Github and this chat application is encrypted:
- Protocol: TLS 1.2
- Cipher suite: ECDHE-ECDSA-AES128-GCM-SHA256
- Key length: 128 bits
- Perfect Forward secrecy: YES
- In this chat application, the access credentials are stored locally in the following way:
- A secure database is used for storing the API tokens for Github and Zoom’s OAuth credentials (both of which are only available to administrators).