GitLab · Schema

WebhookInput

WebhookInput from GitLab API

CodePlatformSoftware DevelopmentSource Control

Properties

Name	Type	Description
url	string	The URL to send webhook POST requests to.
name	string	Optional name for the webhook.
description	string	Optional description of the webhook.
secret_token	string	A secret token to validate received payloads. Sent as the X-Gitlab-Token header.
enable_ssl_verification	boolean	Whether to verify SSL certificates on the webhook URL.
push_events	boolean	Trigger on push events.
tag_push_events	boolean	Trigger on tag push events.
issues_events	boolean	Trigger on issue events.
confidential_issues_events	boolean	Trigger on confidential issue events.
merge_requests_events	boolean	Trigger on merge request events.
note_events	boolean	Trigger on comment events.
confidential_note_events	boolean	Trigger on confidential comment events.
job_events	boolean	Trigger on job status change events.
pipeline_events	boolean	Trigger on pipeline status change events.
wiki_page_events	boolean	Trigger on wiki page events.
deployment_events	boolean	Trigger on deployment events.
releases_events	boolean	Trigger on release events.
member_events	boolean	Trigger on group member events.
push_events_branch_filter	string	Branch name or wildcard pattern to filter push events.

View JSON Schema on GitHub

JSON Schema

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