GitHub · Schema

hook-delivery-item

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

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

Properties

Name	Type	Description
id	integer	Unique identifier of the webhook delivery.
guid	string	Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
delivered_at	string	Time when the webhook delivery occurred.
redelivery	boolean	Whether the webhook delivery is a redelivery.
duration	number	Time spent delivering.
status	string	Describes the response returned after attempting the delivery.
status_code	integer	Status code received when delivery was made.
event	string	The event that triggered the delivery.
action	string	The type of activity for the event that triggered the delivery.
installation_id	integer	The id of the GitHub App installation associated with this event.
repository_id	integer	The id of the repository associated with this event.
throttled_at	string	Time when the webhook delivery was throttled.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-repo-hooks-api-hook-delivery-item-schema.json",
  "title": "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": "integer",
      "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": "string",
      "format": "date-time",
      "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": "number",
      "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": "integer",
      "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": "integer",
      "example": 123
    },
    "repository_id": {
      "description": "The id of the repository associated with this event.",
      "type": "integer",
      "example": 123
    },
    "throttled_at": {
      "description": "Time when the webhook delivery was throttled.",
      "type": "string",
      "format": "date-time",
      "example": "2021-05-12T20:33:44Z"
    }
  },
  "required": [
    "id",
    "guid",
    "delivered_at",
    "redelivery",
    "duration",
    "status",
    "status_code",
    "event",
    "action",
    "installation_id",
    "repository_id"
  ]
}