Using Zoom’s GitHub notifications integration

GitHub notifications are now available through Zoom’s integration with GitHub, which allows you to receive Zoom chat notifications about changes to your GitHub repository and messages from a chatbot about them.

Prerequisites for Zoom’s GitHub integration

• An account on GitHub is required

• Zoom App Marketplace pre-approval of the GitHub Chat Chatbot in the Marketplace of Zoom Apps
  Note: You will need to contact your Zoom admin if the app has not been pre-approved.

How to install and configure GitHub Notifications

Install from the Zoom App Marketplace

1. Log in with your Zoom account to access the Zoom App Marketplace.

2. The app can be found in the search box on the top right of your screen if you enter GitHub into it.

3. Find the GitHub app in the search results and click on it to open it.
   Note: It is important to contact your Zoom admin to get this app approved for your account if the app has not been pre-approved.

4. Please click on the Add button.

5. Once you have confirmed the permissions the app needs, click the Allow button.
   Note: GitHub will automatically be installed for you in the Zoom desktop client if your admin has installed the GitHub app on your computer.

Configure the GitHub subscription

There is a GitHub Add Subscription page that you will be redirected to once you’ve installed the app from the Zoom App Marketplace.

1. It is time for you to authenticate your account on GitHub.

2. To continue, click the Authenticate button.
   We will redirect you to Google’s GitHub to verify your GitHub account and to allow Zoom to access your GitHub account. The subscription configuration page will be returned to you once you have completed the process.

How to use the GitHub Chatbot

Add a subscription

Note: If you would like to subscribe to a GitHub repository, you need to be an admin of that repository in order to do so.

1. When you have authenticated your GitHub account, click on the Add a Subscription button.

2. This page should be completed as soon as possible.

   • Subscriptions can be named as you wish.

   • Depending on the channel you choose, you will be notified about new posts in your channel.

   • Describe the subscription in a few words.

3. Please complete the configuration page on the GitHub website.

   • From your GitHub repository, you will need to select the project(s) you want to work on.

   • By selecting the checkboxes next to the Events you wish to receive information on, you can select which notifications you want to receive.

The Zoom Chat notifications will start showing up to you as soon as you complete the process for each subscription, depending on how you configured it.

Interact with the GitHub Chatbot

In the Zoom chat channel which you have configured, you will start receiving chat notifications once you have added a subscription.

Available commands

Help command

You can find a list of all the available commands by typing help.

Connect command

You can connect your GitHub branches or repositories by typing connect.

A subscription will be added to the channel you entered this command in as soon as the command is submitted. The first thing you need to do is connect your GitHub account in order to be able to connect your repositories.

In order to correct the syntax that is used, you will see a message once you have connected.

If you connect both a repository and a branch under it, you will be able to access just the repository, leaving the branches out of the connection. It will not be possible for you to connect the branches of this repository within the same channel if you have already connected the branches of one repository with the channel.

Comment command

If you would like to add a comment to a ticket, type comment. To use the syntax comment, you need to press Shift+Enter followed by <comment>

It will be necessary for you to:

1. Please specify the full name of the repository as well as the issue number.

2. A new line can be started by pressing Shift + Enter at the same time.

3. Feel free to leave a comment below.

Disconnect command

By typing disconnect, you will be able to disconnect your account from GitHub.

There is a command that will disconnect only those connections that belong to the owner of the channel if you use it. If you want to disconnect a repository or branch, you must use the exact same name as the repository or branch, for example, you cannot disconnect the repository with the branch with the same name as the repository, for example.

How to remove the GitHub Chatbot

1. Log in with your Zoom account to access the Zoom App Marketplace.

2. Click on the Manage button at the top of the page, which can be found in the right corner.

3. Select the Added Apps option from the navigation menu at the top of the page.

4. Select the Github app from the list of apps and click the Remove button.

5. Click on the Remove button after you have confirmed the dialog box.

Data security

• Using this app, you will be able to access the following Zoom information:

  • Using the Zoom account, you can view all the groups that a Zoom user has subscribed to.

  • The Zoom account allows you to view the details of existing meetings for a Zoom user.

  • Under the Zoom account, you can view information about a Zoom user.

• There is information on Github that can be accessed by this app, including the following:

  • The tickets you sell, the agents you work with, and the customers you serve.

    • We have read-only access to the accounts of our agents and customers.

    • We only use write permission to close tickets, which is the only thing we do with it.

• Zoom allows the following permissions for this chat app to operate:

  • A chat message can be sent through this chat app to a Zoom user, or to an IM channel in an IM conversation.

  • There is an option to set up a Zoom meeting using this chat app that can be used by any Zoom user under a Zoom account.

• There is an encrypted channel of communication between Zoom/Github and this chat app:

  • Protocol: TLS 1.2

  • Cipher suite: ECDHE-ECDSA-AES128-GCM-SHA256

  • Key length: 128 bits

  • Perfect Forward secrecy: YES

• The following credentials are stored in the local data store of this chat app:

  • A database containing Zoom OAuth credentials, as well as Github API tokens (both admin level only), is encrypted and secure.

Zoom Support can provide you with additional assistance if you need it.