GitLab · JSON Structure

Gitlab Webhooks Webhook Event Structure

WebhookEvent from GitLab API

Type: object Properties: 10
CodePlatformSoftware DevelopmentSource Control

WebhookEvent is a JSON Structure definition published by GitLab, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id url trigger request_headers request_data response_headers response_body response_status execution_duration created_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gitlab/refs/heads/main/json-structure/gitlab-webhooks-webhook-event-structure.json",
  "name": "WebhookEvent",
  "description": "WebhookEvent from GitLab API",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "The unique identifier of the webhook event delivery.",
      "example": 42
    },
    "url": {
      "type": "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": "double",
      "description": "Time in milliseconds the webhook delivery took.",
      "example": 42.5
    },
    "created_at": {
      "type": "datetime",
      "description": "The date and time the event was delivered.",
      "example": "2026-04-17T12:00:00Z"
    }
  }
}