# Griffin

## Docs

- [API Authentication](https://docs.getgriffinapp.com/api-reference/authentication.md): Authenticating with the Griffin Hub API
- [Delete Connection](https://docs.getgriffinapp.com/api-reference/connections/delete-connection.md): Delete a provider connection by ID. Integrations referencing it will have connectionId set to null.
- [Get Connection](https://docs.getgriffinapp.com/api-reference/connections/get-connection.md): Get a single provider connection by ID.
- [Get Connections](https://docs.getgriffinapp.com/api-reference/connections/get-connections.md): Get a list of provider connections for the organization.
- [Get ](https://docs.getgriffinapp.com/api-reference/get-.md)
- [Create Integration](https://docs.getgriffinapp.com/api-reference/integrations/create-integration.md): Create a new integration. Credentials can be supplied inline (a provider connection is created or updated) or reference an existing connectionId.
- [Delete Integration](https://docs.getgriffinapp.com/api-reference/integrations/delete-integration.md): Delete an integration by ID.
- [Get Integration](https://docs.getgriffinapp.com/api-reference/integrations/get-integration.md): Get a single integration by ID.
- [Initiate OAuth](https://docs.getgriffinapp.com/api-reference/integrations/initiate-oauth.md): Start an OAuth flow. Returns transactionId, authUrl, and expiresAt. The user opens authUrl in a browser to authorize; then poll status until complete.
- [List Integration Providers](https://docs.getgriffinapp.com/api-reference/integrations/list-integration-providers.md): List supported integration providers (metadata for connect flows).
- [List Integrations](https://docs.getgriffinapp.com/api-reference/integrations/list-integrations.md): List integrations for the organization. Supports filtering by category, provider, environment, and enabled status.
- [OAuth Transaction Status](https://docs.getgriffinapp.com/api-reference/integrations/oauth-transaction-status.md): Poll this to check if the OAuth flow completed. Returns status (pending, completed, expired, failed), integrationId when completed, and errorMessage when failed.
- [Slack Events Webhook](https://docs.getgriffinapp.com/api-reference/integrations/slack-events-webhook.md): Slack Events API endpoint. Handles url_verification, app_uninstalled, tokens_revoked, and app_home_opened events. No auth; verified via Slack signature.
- [Slack OAuth Callback](https://docs.getgriffinapp.com/api-reference/integrations/slack-oauth-callback.md): OAuth callback for Slack. Redirects here after user authorizes the app. Completes the flow and creates or updates the integration.
- [Start OAuth (Redirect)](https://docs.getgriffinapp.com/api-reference/integrations/start-oauth-redirect.md): Browser endpoint. Redirects to the OAuth provider's authorize URL. Use the transactionId from initiate.
- [Update Integration](https://docs.getgriffinapp.com/api-reference/integrations/update-integration.md): Update an integration by ID. Supports name, config, connectionId, environment, and enabled.
- [List Locations](https://docs.getgriffinapp.com/api-reference/locations/list-locations.md): Returns available executor locations (derived from queue configuration). Read-only; used by clients to validate monitor.locations and display options.
- [Get Metrics Summary](https://docs.getgriffinapp.com/api-reference/metrics/get-metrics-summary.md): High-level health summary across all monitors for the organization. Includes pass/fail counts, success rate, latency percentiles, and failing monitors.
- [Get Monitor Metrics](https://docs.getgriffinapp.com/api-reference/metrics/get-monitor-metrics.md): Detailed metrics for a single monitor, including runs summary, latency stats, recent failures, and error distribution.
- [List Monitors with Metrics](https://docs.getgriffinapp.com/api-reference/metrics/list-monitors-with-metrics.md): List monitors with aggregated metrics (paginated). Supports filtering by environment and status, and sorting.
- [Create Monitor](https://docs.getgriffinapp.com/api-reference/monitor/create-monitor.md): Create a new monitor. Notification rules can be included and are synced to the notification system.
- [Delete Monitor](https://docs.getgriffinapp.com/api-reference/monitor/delete-monitor.md): Delete a monitor by ID. The monitor must belong to the organization.
- [Get Monitor by Name](https://docs.getgriffinapp.com/api-reference/monitor/get-monitor-by-name.md): Get a single monitor by project, environment, and name. Optional version (e.g. latest) can migrate the monitor schema.
- [List Monitors](https://docs.getgriffinapp.com/api-reference/monitor/list-monitors.md): List monitors for the organization with optional filtering by project and environment. Supports pagination.
- [Update Monitor](https://docs.getgriffinapp.com/api-reference/monitor/update-monitor.md): Update an existing monitor by ID. Notification rules are synced from the request body.
- [Get Notification Event](https://docs.getgriffinapp.com/api-reference/notifications/get-notification-event.md): Get a single notification event by ID. Used by notification workers for idempotency checks.
- [Get Notification Rule](https://docs.getgriffinapp.com/api-reference/notifications/get-notification-rule.md): Get a single notification rule by ID.
- [List Events by Rule](https://docs.getgriffinapp.com/api-reference/notifications/list-events-by-rule.md): Return notification events for a rule, optionally filtered by integration ID.
- [List Notification Events](https://docs.getgriffinapp.com/api-reference/notifications/list-notification-events.md): List notification events with optional filtering by rule. Supports limit and offset.
- [List Notification Rules](https://docs.getgriffinapp.com/api-reference/notifications/list-notification-rules.md): List notification rules. Rules are read-only here; they are created and updated via monitor sync (e.g. griffin hub apply).
- [Resolve Notification Channel](https://docs.getgriffinapp.com/api-reference/notifications/resolve-notification-channel.md): Resolve channel adapter input for building an adapter remotely (buildChannelAdapter(data)). Used by distributed notification workers.
- [Send Test Notification](https://docs.getgriffinapp.com/api-reference/notifications/send-test-notification.md): Send a test notification via a configured integration (same path as production).
- [Update Event Delivery Status](https://docs.getgriffinapp.com/api-reference/notifications/update-event-delivery-status.md): Update a notification event's delivery status (used by notification workers after dispatch). When status.channelMeta is set, it is merged into channelsNotified for that channel.
- [API Overview](https://docs.getgriffinapp.com/api-reference/overview.md): Griffin Hub REST API reference
- [Get Run](https://docs.getgriffinapp.com/api-reference/runs/get-run.md): Get a specific job run by ID.
- [List Runs](https://docs.getgriffinapp.com/api-reference/runs/list-runs.md): List job runs with optional filtering by monitor and status. Supports pagination.
- [Trigger Run](https://docs.getgriffinapp.com/api-reference/runs/trigger-run.md): Manually trigger a monitor execution. Creates a job run and enqueues it for the specified environment.
- [Update Run](https://docs.getgriffinapp.com/api-reference/runs/update-run.md): Update a job run (used by agents to report results). Supports status, completedAt, duration_ms, success, errors, and browser. Requires auth (api-key or OIDC).
- [Create or Update Secret](https://docs.getgriffinapp.com/api-reference/secrets/create-or-update-secret.md): Create or update a secret by name. Secret value is stored in a consolidated JSON KV map in AWS Secrets Manager.
- [Delete Secret](https://docs.getgriffinapp.com/api-reference/secrets/delete-secret.md): Delete a secret by name from the consolidated KV map. If the map becomes empty, the SM secret is deleted.
- [Get Secret Metadata](https://docs.getgriffinapp.com/api-reference/secrets/get-secret-metadata.md): Check if a secret exists by name. Returns the secret name if found.
- [List Secrets](https://docs.getgriffinapp.com/api-reference/secrets/list-secrets.md): List secret names for the organization and environment.
- [Resolve Secret Value](https://docs.getgriffinapp.com/api-reference/secrets/resolve-secret-value.md): Resolve a secret value by name. The hub reads the value from AWS Secrets Manager and returns it. Uses POST to keep secret values out of URLs and query logs.
- [Authentication](https://docs.getgriffinapp.com/cli/authentication.md): Connect the CLI to Griffin Cloud or a self-hosted hub
- [Core Commands](https://docs.getgriffinapp.com/cli/core-commands.md): Griffin CLI command reference
- [Environments](https://docs.getgriffinapp.com/cli/environments.md): CLI commands for managing environments
- [Plan & Apply](https://docs.getgriffinapp.com/cli/plan-apply.md): Preview and push changes to the hub
- [Runs & Metrics](https://docs.getgriffinapp.com/cli/runs-metrics.md): View execution history and performance data
- [Architecture](https://docs.getgriffinapp.com/concepts/architecture.md): How Griffin's components work together
- [Cloud vs Self-Host](https://docs.getgriffinapp.com/concepts/cloud-vs-self-host.md): Choose between Griffin Cloud and self-hosting Griffin Hub
- [Environments](https://docs.getgriffinapp.com/concepts/environments.md): Run the same monitors against different deployments
- [Execution Model](https://docs.getgriffinapp.com/concepts/execution-model.md): How Griffin executes monitors as graphs
- [Comparisons](https://docs.getgriffinapp.com/getting-started/comparisons.md): How Griffin compares to other API monitoring tools
- [Installation](https://docs.getgriffinapp.com/getting-started/installation.md): Install the Griffin CLI
- [Introduction](https://docs.getgriffinapp.com/getting-started/introduction.md): Griffin is an open-source API monitoring platform for production
- [Quickstart](https://docs.getgriffinapp.com/getting-started/quickstart.md): Write and run your first API test in minutes
- [Billing](https://docs.getgriffinapp.com/griffin-cloud/billing.md): Griffin Cloud pricing and billing
- [Members & Roles](https://docs.getgriffinapp.com/griffin-cloud/members-roles.md): Manage team access with role-based permissions
- [Organizations](https://docs.getgriffinapp.com/griffin-cloud/organizations.md): Collaborate with your team on Griffin Cloud
- [Griffin Cloud Overview](https://docs.getgriffinapp.com/griffin-cloud/overview.md): Managed API monitoring platform
- [Configuration](https://docs.getgriffinapp.com/griffin-hub/configuration.md): Environment variables for Griffin Hub
- [Griffin Hub Overview](https://docs.getgriffinapp.com/griffin-hub/overview.md): The control plane for Griffin's API monitoring
- [Self-Hosting Guide](https://docs.getgriffinapp.com/griffin-hub/self-hosting.md): Deploy Griffin Hub on your own infrastructure
- [Integrations](https://docs.getgriffinapp.com/platform/integrations.md): Connect Griffin to external services
- [Metrics](https://docs.getgriffinapp.com/platform/metrics.md): Track success rates, latency, and uptime
- [Monitors](https://docs.getgriffinapp.com/platform/monitors.md): Managing your deployed API monitors
- [Notifications](https://docs.getgriffinapp.com/platform/notifications.md): Get alerted when monitors fail
- [Runs](https://docs.getgriffinapp.com/platform/runs.md): Viewing test execution history
- [Assertions](https://docs.getgriffinapp.com/writing-tests/assertions.md): Validate API responses and browser page state with a fluent assertion DSL
- [Browser Monitors](https://docs.getgriffinapp.com/writing-tests/browser-monitors.md): Monitor web pages with Playwright — navigate, click, fill forms, and assert on page state
- [Frequencies & Scheduling](https://docs.getgriffinapp.com/writing-tests/frequencies.md): Control how often your monitors run
- [Graph Builder](https://docs.getgriffinapp.com/writing-tests/graph-builder.md): Build complex monitor flows with explicit control over execution order
- [Secrets](https://docs.getgriffinapp.com/writing-tests/secrets.md): Keep sensitive values out of your monitor files
- [Sequential Builder](https://docs.getgriffinapp.com/writing-tests/sequential-builder.md): The simplest way to write linear API and browser monitor flows
- [Variables](https://docs.getgriffinapp.com/writing-tests/variables.md): Configure monitors differently per environment

## OpenAPI Specs

- [json](https://hub.griff.services/documentation/json)
- [openapi](https://docs.getgriffinapp.com/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/griffin-open-source/griffin)