Connect your organization to GitHub, GitLab, or Bitbucket to seamlessly sync repositories and manage source code directly within the platform. This guide walks you through installing, configuring, and managing your Git provider integrations.
How the integration works
Our platform uses a secure OAuth flow to connect to your Git provider. This ensures you never have to share your passwords with us.
sequenceDiagram
participant User
participant Platform
participant GitProvider as Git Provider
User->>Platform: Request Installation URL
Platform-->>User: Returns OAuth URL
User->>GitProvider: Authorize Application
GitProvider-->>Platform: OAuth Callback with Token
Platform->>GitProvider: Fetch Repositories
GitProvider-->>Platform: Repository List
Platform-->>User: Installation CompleteSetting up your integration
Connecting a new Git provider takes just a few clicks.
- 1
Get the installation URL
Start by requesting the unique installation URL for your organization. This URL directs you to the Git provider's secure authorization page.
- 2
Authorize the application
Follow the link to your Git provider (like GitHub or GitLab) and grant the necessary permissions. Once approved, the provider will redirect you back to our platform via a secure callback.
- 3
Sync your repositories
After a successful connection, trigger a repository sync to pull in your latest projects, file trees, and metadata.
You can connect multiple Git providers to a single organization. For example, you can have both GitHub and Bitbucket installations active at the same time.
Managing your installations
Once connected, you can view and manage your active Git provider installations from your organization settings.
| Action | Description |
|---|---|
| View Installations | See all active Git provider connections for your organization. |
| View Details | Inspect a specific installation by its unique ID to check its health and status. |
| Delete Installation | Remove a Git provider connection and permanently revoke access. |
Deleting an installation immediately revokes access to the associated repositories. Any automated workflows depending on those repositories will fail until the provider is reconnected.
Working with repositories
After your Git provider is installed and synced, you can interact with your code directly through the platform. The integration allows you to:
List Repositories: View all repositories your organization has access to.
View Repository Details: Inspect the metadata and status of a specific repository by its ID.
View File Trees: Browse the directory structure of a specific repository.
Read File Content: Retrieve the raw content of individual files for analysis or processing.
If you create a new repository on your Git provider, you may need to manually trigger a Sync to make it visible in the platform.
Automating syncs via API
If you are building custom workflows, you can trigger a repository sync programmatically using our API.
curl -X POST "https://api.yourdomain.com/v1/organizations/{organization_id}/git-provider/repositories/sync"
-H "Authorization: Bearer YOUR_API_TOKEN"Frequently asked questions
What permissions are required?
Our platform requests read-only access to your repositories and file contents by default. We only request write access if you explicitly enable features that require committing code back to your provider.
How do I completely disconnect a provider?
First, delete the installation from your organization settings in our platform. Then, we recommend navigating to your Git provider's settings (e.g., GitHub's "Authorized OAuth Apps") and revoking the grant there for complete security.