Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.garnet.ai/llms.txt

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

Garnet publishes results through multiple channels — no extra configuration needed for GitHub, optional setup for Slack and HTTP webhooks.

GitHub (automatic)

Every monitored run automatically produces:
  • PR comment — check results and egress summary posted directly on the pull request (requires pull-requests: write permission)
  • Job Summary — runtime report with check results, egress table, and a link to the full profile. See GitHub Actions → Job Summary.

Webhooks

Garnet settings page showing API tokens and alerting configuration
Configure Slack or custom HTTP webhooks under SettingsAlerting at app.garnet.ai. Slack: Create an Incoming Webhook in your Slack workspace, then paste the URL in SettingsAlertingAdd Webhook. Failed checks trigger a notification with the run link, repository, and evidence summary. HTTP: Point any endpoint at your webhook URL. Garnet sends a POST with a JSON payload containing the run ID, repository, check results, and flagged domains.

Settings overview

SectionWhat it covers
SetupOnboarding links and quickstart guides
API TokensCreate, view, and revoke project tokens
AlertingSlack and HTTP webhook configuration
UsageRun counts and agent metrics
Store API tokens in CI secrets or vault — never commit or log them in plain text.