WebhookInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gitlab/main/json-schema/gitlab-webhook-input-schema.json",
  "title": "WebhookInput",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gitlab-project-webhooks-api-openapi.yml#/components/schemas/WebhookInput",
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL to send webhook POST requests to."
    },
    "name": {
      "type": "string",
      "description": "Optional name for the webhook."
    },
    "description": {
      "type": "string",
      "description": "Optional description of the webhook."
    },
    "secret_token": {
      "type": "string",
      "description": "A secret token to validate received payloads. Sent as the X-Gitlab-Token header."
    },
    "enable_ssl_verification": {
      "type": "boolean",
      "description": "Whether to verify SSL certificates on the webhook URL."
    },
    "push_events": {
      "type": "boolean",
      "description": "Trigger on push events."
    },
    "tag_push_events": {
      "type": "boolean",
      "description": "Trigger on tag push events."
    },
    "issues_events": {
      "type": "boolean",
      "description": "Trigger on issue events."
    },
    "confidential_issues_events": {
      "type": "boolean",
      "description": "Trigger on confidential issue events."
    },
    "merge_requests_events": {
      "type": "boolean",
      "description": "Trigger on merge request events."
    },
    "note_events": {
      "type": "boolean",
      "description": "Trigger on comment events."
    },
    "confidential_note_events": {
      "type": "boolean",
      "description": "Trigger on confidential comment events."
    },
    "job_events": {
      "type": "boolean",
      "description": "Trigger on job status change events."
    },
    "pipeline_events": {
      "type": "boolean",
      "description": "Trigger on pipeline status change events."
    },
    "wiki_page_events": {
      "type": "boolean",
      "description": "Trigger on wiki page events."
    },
    "deployment_events": {
      "type": "boolean",
      "description": "Trigger on deployment events."
    },
    "releases_events": {
      "type": "boolean",
      "description": "Trigger on release events."
    },
    "member_events": {
      "type": "boolean",
      "description": "Trigger on group member events."
    },
    "push_events_branch_filter": {
      "type": "string",
      "description": "Branch name or wildcard pattern to filter push events."
    }
  }
}