Skip to content
POST/api/v1/integrations/github

Configure GitHub integration

Connects the org to a GitHub organization for PR comments, deployment hooks, code review automation. Uses OAuth 2.0 + PKCE; tokens encrypted via BYOK (ADR-0008).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "action": "string",
  "evalConfigPath": "string",
  "schedule": "string",
  "threshold": 0,
  "outputFormat": "summary"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "action": {
          "type": "string",
          "maxLength": 100
        },
        "evalConfigPath": {
          "type": "string",
          "maxLength": 500
        },
        "schedule": {
          "type": "string",
          "maxLength": 200
        },
        "result": {},
        "threshold": {
          "type": "number"
        },
        "outputFormat": {
          "type": "string",
          "enum": [
            "summary",
            "annotations",
            "both"
          ]
        }
      },
      "required": [
        "action"
      ],
      "additionalProperties": {}
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Configured.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/integrations/github \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "string", "evalConfigPath": "string", "schedule": "string", "threshold": 0, "outputFormat": "summary" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/integrations/github",
  body: {
    "action": "string",
    "evalConfigPath": "string",
    "schedule": "string",
    "threshold": 0,
    "outputFormat": "summary"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/integrations/github",
    body={
    "action": "string",
    "evalConfigPath": "string",
    "schedule": "string",
    "threshold": 0,
    "outputFormat": "summary"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"action":"string","evalConfigPath":"string","schedule":"string","threshold":0,"outputFormat":"summary"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/integrations/github", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other Integrations endpoints