GIgitcafe
Webhooks

Inspect webhook readiness

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.

get/api/repos/{owner}/{repo}/webhooks/{webhookId}/readiness

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token
    • or OAuth 2
      Authorization code: /api/oauth/authorize
      Token URL: /api/oauth/token scopes: repo:webhooks:read

Path parameters

ownerstring required
repostring required
webhookIdstring required

Response

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

apiVersion'1' required
supportedEventsWebhookEventType[] required
encryptionConfiguredboolean required
execution'disabled' | 'invalid' | 'configured' required
activeboolean required
destinationAllowedboolean required
apiVersionSupportedboolean required
unsupportedSubscriptionsstring[] required
readyboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.