Skip to main content

​
Overview

You use this module to connect GitHub App installations, query repositories, and receive GitHub webhook events.

​
Endpoints

​
GET /github/connect

Returns a GitHub App installation URL for the authenticated user.
  • Auth: Authorization: Bearer <access_token>
  • Response field:
  • installUrl

​
GET /github/app/callback

Handles GitHub App installation callback.
  • Auth: none
  • Query params:
  • installation_id (required, positive number)
  • state (required)
  • Behavior: validates callback, links installation, then redirects to frontend connected accounts page

​
GET /github/repositories

Lists repositories available for the authenticated user.
  • Auth: Authorization: Bearer <access_token>

​
POST /github/webhook

Receives and processes GitHub webhook events.
  • Auth: signature-based, not Bearer token
  • Required headers:
  • x-github-event
  • x-hub-signature-256
  • Request requirement: backend must receive raw request body for signature verification
Success response: 
{
  "ok": true
}
If signature validation fails, the endpoint returns an error and does not process the event.