---
title: "Inspect webhook readiness"
method: GET
path: "/api/repos/{owner}/{repo}/webhooks/{webhookId}/readiness"
tags: ["Webhooks"]
---

# Inspect webhook readiness

`GET /api/repos/{owner}/{repo}/webhooks/{webhookId}/readiness`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/webhooks/{webhookId}/readiness`
- Auth: one of:
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `repo:webhooks:read`

Beta: webhook event coverage and payload schemas may evolve. See /docs/integrations/webhooks for supported events and delivery limits. Returns endpoint activation, destination admission and signing configuration; no network request is made. Requires authenticated authority and enforces current resource policy.

## Path parameters

- `owner` string, required
- `repo` string, required
- `webhookId` string, required

## Response `200`

Beta: webhook event coverage and payload schemas may evolve. See /docs/integrations/webhooks for supported events and delivery limits.

- WebhookReadiness: Beta: webhook event coverage and payload schemas may evolve. See /docs/integrations/webhooks for supported events and delivery limits.
  - `apiVersion` '1', required
  - `supportedEvents` WebhookEventType[], required
  - `encryptionConfigured` boolean, required
  - `execution` 'disabled' | 'invalid' | 'configured', required
  - `active` boolean, required
  - `destinationAllowed` boolean, required
  - `apiVersionSupported` boolean, required
  - `unsupportedSubscriptions` string[], required
  - `ready` boolean, required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)