Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

Connecting GitHub or GitLab gives Scrubbe visibility into your deployments and pipelines. When a deployment fails or a pipeline job breaks, Scrubbe ingests the event and correlates it with active incidents using the commit SHA and deployment metadata. You need the ENGINEER role or higher to connect either integration.

​
Connect GitHub

1

Initiate the OAuth flow

Send an authenticated request to the GitHub connect endpoint. Scrubbe returns a GitHub OAuth authorization URL.
POST /api/v1/integrations/github/connect
Authorization: Bearer <your-access-token>
Response:
{
  "success": true,
  "message": "GitHub OAuth URL generated",
  "data": {
    "url": "https://github.com/login/oauth/authorize?client_id=..."
  }
}
2

Authorize in GitHub

Open the returned url in your browser. GitHub will ask you to authorize Scrubbe to access your repositories. After you click Authorize, GitHub redirects to the Scrubbe callback endpoint automatically.
3

Scrubbe completes the connection

Scrubbe handles the OAuth callback at:
GET /api/v1/integrations/github/callbacks/github
You do not need to call this endpoint directly. After the callback succeeds, your GitHub account is linked and Scrubbe can access your repositories.
4

List and save repositories

Fetch the repositories available on your connected GitHub account:
GET /api/v1/integrations/github/repos
Authorization: Bearer <your-access-token>
Then save the repositories you want Scrubbe to monitor:
PATCH /api/v1/integrations/github/repos
Authorization: Bearer <your-access-token>
Content-Type: application/json

{
  "repos": ["your-org/api-service", "your-org/frontend"]
}
5

Register the webhook in GitHub

In your GitHub repository settings, add a webhook pointing to the Scrubbe ingestion endpoint:
  • Payload URL: https://your-scrubbe-instance/api/v1/ingestion/github
  • Content type: application/json
  • Events: Select Workflow runs and Deployment statuses
  • Secret: Use your Scrubbe API key as the webhook secret
Scrubbe also exposes a lower-level integration webhook at POST /api/v1/integrations/github/webhook which handles signature-verified push and deployment events at the integration layer.

​
How GitHub events map to incidents

When a deployment_status event with a failure state arrives, Scrubbe creates or updates an incident ticket with:
  • The commit SHA from the deployment payload
  • The repository and environment name
  • A severity of ERROR or CRITICAL depending on the failure type
When a workflow_run event with a failure conclusion arrives, Scrubbe records a BUILD_FAILED signal and links it to any open incident for the same service and environment.

​
Deployment correlation

Regardless of whether you use GitHub or GitLab, Scrubbe links deployment signals to open incident tickets by matching the service name and environment. When a deployment failure arrives for a service that already has an open incident, Scrubbe attaches the deployment metadata to that ticket rather than opening a new one. You can view the linked deployment details in the incident’s Changes panel.
You can also initiate the OAuth flow with a GET request to /api/v1/integrations/github/connect or /api/v1/integrations/gitlab/connect if you prefer to navigate directly from a browser.