GitHub integration
Link pull requests, branches, and commits to tasks, and automate status updates
Overview
The Vaiz GitHub integration brings your development workflow directly into your project management workspace. By connecting your GitHub repositories to Vaiz, you can link pull requests, branches, and commits to tasks. This gives your entire team complete visibility into the status of development without developers having to double-enter status updates.
With this integration, you can also create new Git branches directly from Vaiz tasks, sync pull request comments with task activity, and automatically post task updates back to GitHub.
Key benefits:
- Full visibility — Track pull requests, branch names, and commits directly in the task sidebar
- Create branches instantly — Generate new Git branches from tasks with automatically formatted names (e.g.,
PROJ-123-feature-name) - Bidirectional sync — Keep your team updated by syncing GitHub comments with Vaiz task activity, and vice versa
- Multi-account support — Connect multiple personal accounts or GitHub organizations to a single Vaiz Space
Pricing
The GitHub integration is included in all Vaiz plans, including the Free plan. No separate purchase or subscription is required to connect Vaiz to your GitHub account or organization.
For details on Vaiz plan pricing and feature limits, visit vaiz.com/pricing.
How to install
The GitHub integration is installed via the GitHub App flow. Follow these steps to get started:
- Sign in to your Vaiz account at vaiz.com
- Open your Space and navigate to App Center → Apps → GitHub
- Click Connect GitHub to begin the installation flow on GitHub
- Select the personal account or organization where you want to install the Vaiz App
- Select whether to grant access to All repositories or Only select repositories
- Click Install & Authorize
Once completed, GitHub will redirect you back to your Vaiz Space. Your repositories will sync automatically and will be visible under the connected accounts settings.
Key features
1. Link Git entities to tasks
Easily link development progress to any Vaiz task. From the task sidebar, click the GitHub field to open the picker and search or select:
- Pull requests — View live status badges (Open, Merged, or Closed) and link directly to the PR on GitHub
- Branches — Link active branches so everyone knows where development is happening
- Commits — Reference specific commits with their short SHA and commit message
2. Create branch from task
Skip the manual git commands. You can create a new branch directly from a Vaiz task sidebar:
- Open a task and click the GitHub field
- Switch to the Create branch tab
- Select the target repository and the base branch (e.g.,
mainordevelop) - Confirm the new branch name (it defaults to the task's human-readable ID and slug, e.g.,
PROJ-123-login-bug) - Click Create branch
The branch is created immediately in your GitHub repository and is automatically linked to the task.
3. Bidirectional activity sync
Keep your developers and product managers on the same page. You can manage these settings with independent toggles in the App Center:
- PR Comments (syncPrComments) — When enabled, comments posted on a linked GitHub pull request are automatically mirrored as comments in the Vaiz task activity log.
- Activity Log (syncTaskActivity) — When enabled, updates in Vaiz (such as moving a task to a different group, assigning members, or updating descriptions) are posted as comments on the connected GitHub pull request.
Permissions and data access
When you connect the Vaiz GitHub App, it requests specific permissions required to enable these integrations. We follow the principle of least privilege:
Permission | Access Level | Purpose |
|---|---|---|
Repository contents | Read & write | Read branch lists to select bases, and write to create new branches directly from tasks. |
Pull requests | Read & write | Read PR status/details and write activity log comments to connected PRs. |
Issues | Read & write | Sync comments on Pull Requests (GitHub handles PR comments as part of the Issues API). |
Metadata | Read-only | List repositories to sync them with your Vaiz Space. |
Vaiz does not request write access to your repository settings, administration, or workflows. We never read or store your code files.
Disconnection and cleanup
You can disconnect any GitHub installation at any time:
- Go to App Center → Apps → GitHub
- Find the connected account or organization and click Disconnect
- If there are active tasks with linked pull requests or branches, Vaiz will show a warning indicating how many items will lose status synchronization.
- Confirm the disconnection
Disconnecting immediately revokes all security tokens. If you wish to completely remove the Vaiz App from your GitHub account, you can also uninstall it from your GitHub Settings → Applications.
Security
All communication between Vaiz and GitHub is encrypted using TLS 1.2 or higher. We store your GitHub App installation tokens and keys in secure, encrypted storage.
Support
If you have questions or need help with the GitHub integration, reach out to us:
- Email: [email protected]
- Help Center: vaiz.com/help