GitHub · JSON Structure

Github Repo Hooks Api Hook Delivery Item Structure

Delivery made by a webhook, without request and response information.

Type: object Properties: 12 Required: 11
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

hook-delivery-item is a JSON Structure definition published by GitHub, describing 12 properties, of which 11 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id guid delivered_at redelivery duration status status_code event action installation_id repository_id throttled_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/github/refs/heads/main/json-structure/github-repo-hooks-api-hook-delivery-item-structure.json",
  "name": "hook-delivery-item",
  "description": "Delivery made by a webhook, without request and response information.",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier of the webhook delivery.",
      "type": "int32",
      "example": 42
    },
    "guid": {
      "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).",
      "type": "string",
      "example": "58474f00-b361-11eb-836d-0e4f3503ccbe"
    },
    "delivered_at": {
      "description": "Time when the webhook delivery occurred.",
      "type": "datetime",
      "example": "2021-05-12T20:33:44Z"
    },
    "redelivery": {
      "description": "Whether the webhook delivery is a redelivery.",
      "type": "boolean",
      "example": false
    },
    "duration": {
      "description": "Time spent delivering.",
      "type": "double",
      "example": 0.03
    },
    "status": {
      "description": "Describes the response returned after attempting the delivery.",
      "type": "string",
      "example": "failed to connect"
    },
    "status_code": {
      "description": "Status code received when delivery was made.",
      "type": "int32",
      "example": 502
    },
    "event": {
      "description": "The event that triggered the delivery.",
      "type": "string",
      "example": "issues"
    },
    "action": {
      "description": "The type of activity for the event that triggered the delivery.",
      "type": "string",
      "example": "opened"
    },
    "installation_id": {
      "description": "The id of the GitHub App installation associated with this event.",
      "type": "int32",
      "example": 123
    },
    "repository_id": {
      "description": "The id of the repository associated with this event.",
      "type": "int32",
      "example": 123
    },
    "throttled_at": {
      "description": "Time when the webhook delivery was throttled.",
      "type": "datetime",
      "example": "2021-05-12T20:33:44Z"
    }
  },
  "required": [
    "id",
    "guid",
    "delivered_at",
    "redelivery",
    "duration",
    "status",
    "status_code",
    "event",
    "action",
    "installation_id",
    "repository_id"
  ]
}