Using Zoom's GitHub notifications app

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

How to install and configure GitHub Notifications

Install from the Zoom App Marketplace

  1. Sign in to the Zoom App Marketplace with your Zoom account.
  2. In the top right of your screen, enter GitHub in the search box to find the app.
  3. 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.
  4. Click Add.
  5. 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.

  1. Authenticate your GitHub account.
  2. 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.

  1. Once your GitHub account has been authenticated, click Add a Subscription.
  2. 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.
  3. 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:

  1. Specify the full repository name and the issue ID.
  2. Use Shift + Enter to start a new line.
  3. 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

  1. Sign in to the Zoom App Marketplace with your Zoom account.
  2. In the top right of the page, click Manage.
  3. In the navigation menu, click Added Apps.
  4. Next to the Github app, click Remove.
  5. Confirm the dialogue and click Remove.

Data security

For additional help, submit a request to Zoom Support.