Zoom’s GitHub notifications integration allows you to receive Zoom Team Chat notifications and messages from an app relating to changes in your GitHub repos.
This article covers:
Prerequisites for Zoom’s GitHub Notifications app
- A GitHub account
- Pre-approval of the GitHub app in the Zoom App Marketplace
Note: If the app is not pre-approved, please contact your Zoom admin.
How to install and configure GitHub Notifications
Install from the Zoom App Marketplace
- Sign in to the Zoom App Marketplace with your Zoom account.
- In the top right of your screen, enter GitHub in the search box to find the app.
- In your search results, find the GitHub app and click it.
Note: If the app is not pre-approved, please contact your Zoom admin to approve this app for your account. - Click Add.
- Confirm the permissions the app requires, then click Allow.
Note: If your admin has installed the GitHub app, it will be automatically installed for you in the Zoom desktop client.
Configure the GitHub subscription
After installing the app from the Zoom App Marketplace, you will be redirected to the GitHub Add Subscription page.
- Authenticate your GitHub account.
- Click Authenticate to continue.
You will be redirected to GitHub to authenticate your GitHub account and authorize Zoom. Once completed, you will return to the subscription configuration page.
How to use the GitHub app
Add a subscription
Note: You must be an admin of the GitHub repository that you are adding a subscription to.
- Once your GitHub account has been authenticated, click Add a Subscription.
- Complete the Basic Configurations page.
- Enter a Name for the subscription.
- Select the Channel you would like to receive notifications from.
- Add a Description of the subscription.
- Complete the GitHub Configurations page.
- Choose the Project(s) from your GitHub repository.
- Choose which Events you would like to receive notifications for by selecting the check boxes.
Once complete, you will start receiving Zoom Team Chat notifications based on your configuration for each subscription.
Interact with the GitHub app
Once you have added a subscription, you will begin to receive chat notifications in the configured Zoom chat channel.
Available commands
Help command
Type help to receive a list of all available commands.
Connect command
Type connect to connect your GitHub repositories or branches.
This command will add a subscription to the channel the command was entered in. Before you can connect your repositories, you must first connect your GitHub account.
Once connected, you will see a message giving more information on the correct syntax.
If you connect both repository and the branches under this repository, only the repository will be connected and will omit the branches. If you have already connected the branches of one repository, you will not be able to connect this repository or other branches of this repository within the same channel.
Comment command
Type comment to add comments to an issue. You will use the syntax comment [Shift+Enter] <comment>
You will need to:
- Specify the full repository name and the issue ID.
- Use Shift + Enter to start a new line.
- Enter your comment.
Disconnect command
To disconnect your GitHub account, type disconnect.
The disconnect command will only disconnect the connections of the owner in the current channel. You must use exactly the same name of the repository or branch to disconnect them, for example, you can’t use disconnect owner/repository to disconnect owner/repository:branch
How to remove the GitHub app
- Sign in to the Zoom App Marketplace with your Zoom account.
- In the top right of the page, click Manage.
- In the navigation menu, click Added Apps.
- Next to the Github app, click Remove.
- Confirm the dialogue and click Remove.
Data security
- This app has access to the following information on Zoom:
- View all groups subscribed to by a Zoom user under the Zoom account.
- View existing meeting details for a Zoom user under the Zoom account.
- View information of a Zoom user under the Zoom account.
- This app has access to the following information on Github:
- Your tickets, agents, and customers.
- Agents and customers are read-only for us.
- The only write permission we use is closing tickets.
- This app has the following permissions on Zoom:
- This app can send a chat message to an IM channel or Zoom user under the Zoom account.
- This app can create a Zoom meeting on behalf of any Zoom user under the Zoom account.
- Communications between this app and Zoom/Github are encrypted:
- Protocol: TLS 1.2
- Cipher suite: ECDHE-ECDSA-AES128-GCM-SHA256
- Key length: 128 bits
- Perfect Forward secrecy: YES
- This app stores access credentials in the local data store:
- Github API tokens and Zoom OAuth credentials (both admin-level only) are stored in an encrypted database.
For additional help, submit a request to Zoom Support.