github/json-structure/github-app-api-hook-delivery-structure.json at main · api-evangelist/github · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-app-api-hook-delivery-structure.json",
  "name": "hook-delivery",
  "description": "Delivery made by a webhook.",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier of the 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 delivery was delivered.",
      "type": "datetime",
      "example": "2021-05-12T20:33:44Z"
    },
    "redelivery": {
      "description": "Whether the delivery is a redelivery.",
      "type": "boolean",
      "example": false
    },
    "duration": {
      "description": "Time spent delivering.",
      "type": "double",
      "example": 0.03
    },
    "status": {
      "description": "Description of the status of the attempted 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",
      "nullable": true
    },
    "installation_id": {
      "description": "The id of the GitHub App installation associated with this event.",
      "type": "int32",
      "example": 123,
      "nullable": true
    },
    "repository_id": {
      "description": "The id of the repository associated with this event.",
      "type": "int32",
      "example": 123,
      "nullable": true
    },
    "url": {
      "description": "The URL target of the delivery.",
      "type": "string",
      "example": "https://www.example.com"
    },
    "request": {
      "type": "object",
      "properties": {
        "headers": {
          "description": "The request headers sent with the webhook delivery.",
          "type": "object",
          "nullable": true,
          "additionalProperties": true
        },
        "payload": {
          "description": "The webhook payload.",
          "type": "object",
          "nullable": true,
          "additionalProperties": true
        }
      },
      "required": [
        "headers",
        "payload"
      ]
    },
    "response": {
      "type": "object",
      "properties": {
        "headers": {
          "description": "The response headers received when the delivery was made.",
          "type": "object",
          "nullable": true,
          "additionalProperties": true
        },
        "payload": {
          "description": "The response payload received.",
          "type": "string",
          "nullable": true,
          "additionalProperties": true
        }
      },
      "required": [
        "headers",
        "payload"
      ]
    }
  },
  "required": [
    "id",
    "guid",
    "delivered_at",
    "redelivery",
    "duration",
    "status",
    "status_code",
    "event",
    "action",
    "installation_id",
    "repository_id",
    "request",
    "response"
  ]
}