Webhooks

Create a repository webhook

Beta: webhook event coverage and payload schemas may evolve. See /docs/integrations/webhooks for supported events and delivery limits. Creates a webhook endpoint and returns its generated secret once. Requires authenticated authority and enforces current resource policy.

post/api/repos/{owner}/{repo}/webhooks/

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:write

Path parameters

ownerstring required
repostring required

Request body

urlstring uri required
eventsstring[] required

Distinct subscriptions. Local issue and pull events listed in /docs/integrations/webhooks are delivered by this version; * includes supported events. Other syntactically valid names are retained for compatibility but produce no deliveries.

activeboolean
secretstring

Response

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

secretstring required

Changes

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