Zoom’s GitHub Enterprise integration allows you to receive Zoom Team Chat notifications and messages from an app relating to changes in your GitHub Enterprise repos. This integration is intended for GitHub Enterprise private servers.
This article covers:
Prerequisites for using the GitHub Enterprise app
- A GitHub Enterprise account
- Pre-approval of the GitHub Enterprise app in Zoom App Marketplace
Note: If the app is not pre-approved, please contact your Zoom admin.
How to install and configure GitHub Enterprise
Install from the Zoom App Marketplace
- Sign in to Zoom App Marketplace as the account administrator.
- In the top right of your screen, enter GitHub Enterprise in the search box to find the app.
- In your search results, find the GitHub Enterprise 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 Enterprise app, it will be automatically installed for you in the Zoom client.
Configure the GitHub Enterprise subscription
After installing the app from the Marketplace, you will be redirected to the GitHub Enterprise Add Subscription page.
- Authenticate your GitHub Enterprise account.
You will need to authorize through your private server by obtaining a Client ID and Client Secret from your account.
- Access your GitHub Enterprise account.
- Click Settings, then click Developer Settings - OAuth Apps.
You will need to add a new OAuth App to allow Zoom to access your reports.
- Enter Zoom for the Application Name and use the following:
Homepage URL: https://applications.zoom.us/github/home
Redirect URI: https://applications.zoom.us/addon/v2/githube/authorization
- Copy the Client ID and Client Secret.
- Return to the GitHub Enterprise Configuration page on Zoom.
- Enter your Server Domain, Client ID, and Client Secret.
- Click Save Configuration.
You will be redirected to your private server GitHub Enterprise account.
- Choose Authorize.
Your GitHub Enterprise account will now be configured for Zoom.
How to use the GitHub Enterprise app
Add a subscription
Note: You must be an admin of the GitHub Enterprise repository that you are adding a subscription to.
Once your GitHub Enterprise account has been configured, add a subscription:
- Access your desired Zoom Chat channel, then enter /githube connect.
You will receive a direct message from the GitHub Enterprise app. Click the link to authenticate, if necessary.
- To configure your repositories, use one of the following commands:
connect <owner>: Connect all repositories of the owner.
connect <owner or repository>: Connect a single repository.
connect <owner/repositroy_1,owner/repository_2>: Connect multiple repositories.
connect <owner/repository:master>: Connect a branch.
- Click the link provided and complete the configuration page:
Name: Name of the configuration.
Channel: The desired channel you want the notifications to appear in.
Projects: Any projects you would like to receive notifications for.
Events: Choose the Commit, Issue, and Pull Request events. Currently, the following are supported:
- Commits push to the repository
- New comment on commit
- Pull request opened/closed
- Issue opened/closed
- Issue comment created/edited/deleted
- Click Save Configuration.
You will now receive notifications based on your configuration.
Interact with the GitHub Enterprise app
Once you have added a subscription, you will begin to receive chat notifications in the configured Zoom chat channel.
Type help to receive a list of all available commands.
Type connect to connect your GitHub Enterprise 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 Enterprise 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.
Type comment to add comments to an issue. You will use the syntax comment <repository> <issue_id> [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.
To disconnect your GitHub Enterprise account, type disconnect.
The disconnect command will only disconnect 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 Enterprise app
- Sign in to 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 Enterprise app, click Remove.
- Confirm the dialogue and click Remove.
- 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.