GitLab · Schema

WebhookEvent

WebhookEvent from GitLab API

CodePlatformSoftware DevelopmentSource Control

Properties

Name Type Description
id integer The unique identifier of the webhook event delivery.
url string The URL the event was delivered to.
trigger string The event type that triggered the webhook delivery.
request_headers object HTTP headers sent with the webhook request.
request_data string The JSON payload body sent in the webhook request.
response_headers object HTTP headers returned in the webhook response.
response_body string The body of the response from the webhook receiver.
response_status string The HTTP response status code returned by the receiver.
execution_duration number Time in milliseconds the webhook delivery took.
created_at string The date and time the event was delivered.
View JSON Schema on GitHub

JSON Schema

gitlab-webhooks-webhook-event-schema.json Raw ↑
{
  "$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-event-schema.json",
  "title": "WebhookEvent",
  "description": "WebhookEvent from GitLab API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique identifier of the webhook event delivery.",
      "example": 42
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL the event was delivered to.",
      "example": "https://gitlab.com/example"
    },
    "trigger": {
      "type": "string",
      "description": "The event type that triggered the webhook delivery.",
      "example": "example_value"
    },
    "request_headers": {
      "type": "object",
      "description": "HTTP headers sent with the webhook request.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "request_data": {
      "type": "string",
      "description": "The JSON payload body sent in the webhook request.",
      "example": "2026-04-17T12:00:00Z"
    },
    "response_headers": {
      "type": "object",
      "description": "HTTP headers returned in the webhook response.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "response_body": {
      "type": "string",
      "description": "The body of the response from the webhook receiver.",
      "example": "example_value"
    },
    "response_status": {
      "type": "string",
      "description": "The HTTP response status code returned by the receiver.",
      "example": "2026-04-17T12:00:00Z"
    },
    "execution_duration": {
      "type": "number",
      "description": "Time in milliseconds the webhook delivery took.",
      "example": 42.5
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the event was delivered.",
      "example": "2026-04-17T12:00:00Z"
    }
  }
}