{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/hook",
"title": "Webhook",
"description": "Webhooks for repositories.",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"description": "Unique identifier of the webhook.",
"example": 42,
"type": "integer"
},
"name": {
"description": "The name of a valid service, use 'web' for a webhook.",
"example": "web",
"type": "string"
},
"active": {
"description": "Determines whether the hook is actually triggered on pushes.",
"type": "boolean",
"example": true
},
"events": {
"description": "Determines what events the hook is triggered for. Default: ['push'].",
"type": "array",
"items": {
"type": "string"
},
"example": [
"push",
"pull_request"
]
},
"config": {
"$ref": "#/components/schemas/webhook-config"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2011-09-06T20:39:23Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2011-09-06T17:26:27Z"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/hooks/1"
},
"test_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/test"
},
"ping_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings"
},
"deliveries_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries"
},
"last_response": {
"$ref": "#/components/schemas/hook-response"
}
},
"required": [
"id",
"url",
"type",
"name",
"active",
"events",
"config",
"ping_url",
"created_at",
"updated_at",
"last_response",
"test_url"
]
}