---
title: "Create an organization webhook"
method: POST
path: "/api/orgs/{slug}/webhooks/"
tags: ["Webhooks"]
---

# Create an organization webhook

`POST /api/orgs/{slug}/webhooks/`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/orgs/{slug}/webhooks/`
- Auth: one of:
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token

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

## Path parameters

- `slug` string, required

## Request body

- object
  - `url` string, uri, required
  - `events` string[], 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.
  - `active` boolean
  - `secret` string

## Response `201`

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

- WebhookCreated: Beta: webhook event coverage and payload schemas may evolve. See /docs/integrations/webhooks for supported events and delivery limits.
  - `endpoint` union, required: Beta: webhook event coverage and payload schemas may evolve. See /docs/integrations/webhooks for supported events and delivery limits.
    - object
      - `id` string, required
      - `url` string, required
      - `events` string[], required
      - `active` boolean, required
      - `version` integer, required
      - `signingKeyVersion` integer, required
      - `pinnedApiVersion` string, nullable, required
      - `consecutiveFailures` integer, required
      - `lastFailureAt` string, date-time, nullable, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `disabledAt` string, date-time, nullable, required
      - `disableReason` string, nullable, required
      - `orgId` string, required
      - `repoId` unknown, required
    - object
      - `id` string, required
      - `url` string, required
      - `events` string[], required
      - `active` boolean, required
      - `version` integer, required
      - `signingKeyVersion` integer, required
      - `pinnedApiVersion` string, nullable, required
      - `consecutiveFailures` integer, required
      - `lastFailureAt` string, date-time, nullable, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `disabledAt` string, date-time, nullable, required
      - `disableReason` string, nullable, required
      - `orgId` unknown, required
      - `repoId` string, required
  - `secret` string, 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)