Integrate with CodeFlow

Connect your GitHub repositories to our deployed CodeFlow instance.

Access the Deployed Instance

Navigate to our hosted CodeFlow instance and sign in with your GitHub account:

Open CodeFlow Engine →

Authorize GitHub Access

When prompted, authorize CodeFlow to access your GitHub repositories. The following permissions are required:

Read access to repository code and metadata
Read/Write access to pull requests and issues
Webhook access for PR events

Install the GitHub App

Install the CodeFlow GitHub App on your organization or personal repositories:

Go to github.com/apps/codeflow-engine
Click Install or Configure
Select the repositories you want CodeFlow to monitor
Confirm the installation

Configure Your Repositories

In the CodeFlow dashboard, configure settings for each connected repository:

AI Analysis Settings: Choose which AI models to use for code review (GPT-4, Claude, etc.)
Workflow Rules: Define automation rules for issue creation and labeling
Notification Preferences: Set up Slack, Teams, or Discord notifications
Quality Gates: Configure thresholds for security and performance checks

Add Configuration File (Optional)

For advanced customization, add an .codeflow.yml configuration file to your repository:

# .codeflow.yml
version: 1
analysis:
  enabled: true
  ai_provider: openai
  model: gpt-4

workflows:
  - name: pr_review
    triggers:
      - pull_request.opened
      - pull_request.synchronize
    actions:
      - ai_analysis
      - security_scan
      - create_issues

notifications:
  slack:
    channel: "#pr-reviews"
  
quality_gates:
  security:
    block_on_critical: true
  coverage:
    minimum: 80

Verify Integration

Test your integration by creating a pull request:

Create a new branch and make some changes
Open a pull request to your main branch
CodeFlow will automatically analyze the PR and post comments
Check the CodeFlow dashboard for detailed analysis results

API Integration

For programmatic access, use the CodeFlow API to integrate with your existing workflows and tools:

# Example: Trigger analysis via API
curl -X POST https://app.codeflow.io/api/v1/analyze \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "repository": "owner/repo",
    "pull_request": 123
  }'

Generate your API token from the CodeFlow Dashboard Settings.

Webhook Events

CodeFlow can send webhook notifications to your systems when analysis is complete:

Event	Description
analysis.completed	Fired when PR analysis finishes
issues.created	Fired when CodeFlow creates new issues
security.alert	Fired when security vulnerabilities are detected
quality.gate.failed	Fired when a quality gate check fails

Need Help?

Check out our GitHub App Quickstart Guide or reach out on GitHub Discussions.