{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhooks_pull_request_5",
"title": "Pull Request",
"type": "object",
"properties": {
"_links": {
"type": "object",
"properties": {
"comments": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"commits": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"html": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"issue": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"review_comment": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"review_comments": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"self": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
},
"statuses": {
"title": "Link",
"type": "object",
"properties": {
"href": {
"type": "string",
"format": "uri-template"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"html",
"issue",
"comments",
"review_comments",
"review_comment",
"commits",
"statuses"
]
},
"active_lock_reason": {
"type": "string",
"nullable": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
"additions": {
"type": "integer"
},
"assignee": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"assignees": {
"type": "array",
"items": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
}
},
"author_association": {
"title": "AuthorAssociation",
"description": "How the author is associated with the repository.",
"type": "string",
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
"auto_merge": {
"title": "PullRequestAutoMerge",
"description": "The status of auto merging a pull request.",
"type": "object",
"nullable": true,
"properties": {
"commit_message": {
"description": "Commit message for the merge commit.",
"type": "string",
"nullable": true
},
"commit_title": {
"description": "Title for the merge commit message.",
"type": "string",
"nullable": true
},
"enabled_by": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"merge_method": {
"description": "The merge method to use.",
"type": "string",
"enum": [
"merge",
"squash",
"rebase"
]
}
},
"required": [
"enabled_by",
"merge_method",
"commit_title",
"commit_message"
]
},
"base": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"ref": {
"type": "string"
},
"repo": {
"title": "Repository",
"description": "A git repository",
"type": "object",
"properties": {
"allow_auto_merge": {
"description": "Whether to allow auto-merge for pull requests.",
"type": "boolean",
"default": false
},
"allow_forking": {
"description": "Whether to allow private forks",
"type": "boolean"
},
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"type": "boolean",
"default": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"type": "boolean",
"default": true
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"type": "boolean",
"default": true
},
"allow_update_branch": {
"type": "boolean"
},
"archive_url": {
"type": "string",
"format": "uri-template"
},
"archived": {
"description": "Whether the repository is archived.",
"type": "boolean",
"default": false
},
"assignees_url": {
"type": "string",
"format": "uri-template"
},
"blobs_url": {
"type": "string",
"format": "uri-template"
},
"branches_url": {
"type": "string",
"format": "uri-template"
},
"clone_url": {
"type": "string",
"format": "uri"
},
"collaborators_url": {
"type": "string",
"format": "uri-template"
},
"comments_url": {
"type": "string",
"format": "uri-template"
},
"commits_url": {
"type": "string",
"format": "uri-template"
},
"compare_url": {
"type": "string",
"format": "uri-template"
},
"contents_url": {
"type": "string",
"format": "uri-template"
},
"contributors_url": {
"type": "string",
"format": "uri"
},
"created_at": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string",
"format": "date-time"
}
]
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string"
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"type": "boolean",
"default": false
},
"deployments_url": {
"type": "string",
"format": "uri"
},
"description": {
"type": "string",
"nullable": true
},
"disabled": {
"description": "Returns whether or not this repository is disabled.",
"type": "boolean"
},
"downloads_url": {
"type": "string",
"format": "uri"
},
"events_url": {
"type": "string",
"format": "uri"
},
"fork": {
"type": "boolean"
},
"forks": {
"type": "integer"
},
"forks_count": {
"type": "integer"
},
"forks_url": {
"type": "string",
"format": "uri"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string",
"format": "uri-template"
},
"git_refs_url": {
"type": "string",
"format": "uri-template"
},
"git_tags_url": {
"type": "string",
"format": "uri-template"
},
"git_url": {
"type": "string",
"format": "uri"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"type": "boolean",
"default": true
},
"has_issues": {
"description": "Whether issues are enabled.",
"type": "boolean",
"default": true
},
"has_pages": {
"type": "boolean"
},
"has_projects": {
"description": "Whether projects are enabled.",
"type": "boolean",
"default": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"type": "boolean",
"default": true
},
"has_discussions": {
"description": "Whether discussions are enabled.",
"type": "boolean",
"default": false
},
"homepage": {
"type": "string",
"nullable": true
},
"hooks_url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"description": "Unique identifier of the repository",
"type": "integer",
"format": "int64"
},
"is_template": {
"type": "boolean"
},
"issue_comment_url": {
"type": "string",
"format": "uri-template"
},
"issue_events_url": {
"type": "string",
"format": "uri-template"
},
"issues_url": {
"type": "string",
"format": "uri-template"
},
"keys_url": {
"type": "string",
"format": "uri-template"
},
"labels_url": {
"type": "string",
"format": "uri-template"
},
"language": {
"type": "string",
"nullable": true
},
"languages_url": {
"type": "string",
"format": "uri"
},
"license": {
"title": "License",
"type": "object",
"nullable": true,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"spdx_id": {
"type": "string"
},
"url": {
"type": "string",
"nullable": true,
"format": "uri"
}
},
"required": [
"key",
"name",
"spdx_id",
"url",
"node_id"
]
},
"master_branch": {
"type": "string"
},
"merge_commit_message": {
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
"merge_commit_title": {
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
"merges_url": {
"type": "string",
"format": "uri"
},
"milestones_url": {
"type": "string",
"format": "uri-template"
},
"mirror_url": {
"type": "string",
"nullable": true,
"format": "uri"
},
"name": {
"description": "The name of the repository.",
"type": "string"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string",
"format": "uri-template"
},
"open_issues": {
"type": "integer"
},
"open_issues_count": {
"type": "integer"
},
"organization": {
"type": "string"
},
"owner": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"triage": {
"type": "boolean"
}
},
"required": [
"pull",
"push",
"admin"
]
},
"private": {
"description": "Whether the repository is private or public.",
"type": "boolean"
},
"public": {
"type": "boolean"
},
"pulls_url": {
"type": "string",
"format": "uri-template"
},
"pushed_at": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string",
"format": "date-time"
}
]
},
"releases_url": {
"type": "string",
"format": "uri-template"
},
"role_name": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer"
},
"squash_merge_commit_message": {
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
"squash_merge_commit_title": {
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
"ssh_url": {
"type": "string"
},
"stargazers": {
"type": "integer"
},
"stargazers_count": {
"type": "integer"
},
"stargazers_url": {
"type": "string",
"format": "uri"
},
"statuses_url": {
"type": "string",
"format": "uri-template"
},
"subscribers_url": {
"type": "string",
"format": "uri"
},
"subscription_url": {
"type": "string",
"format": "uri"
},
"svn_url": {
"type": "string",
"format": "uri"
},
"tags_url": {
"type": "string",
"format": "uri"
},
"teams_url": {
"type": "string",
"format": "uri"
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"trees_url": {
"type": "string",
"format": "uri-template"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
},
"use_squash_pr_title_as_default": {
"description": "Whether a squash merge commit can use the pull request title as default.",
"type": "boolean",
"default": false
},
"visibility": {
"type": "string",
"enum": [
"public",
"private",
"internal"
]
},
"watchers": {
"type": "integer"
},
"watchers_count": {
"type": "integer"
},
"web_commit_signoff_required": {
"description": "Whether to require contributors to sign off on web-based commits",
"type": "boolean"
}
},
"required": [
"id",
"node_id",
"name",
"full_name",
"private",
"owner",
"html_url",
"description",
"fork",
"url",
"forks_url",
"keys_url",
"collaborators_url",
"teams_url",
"hooks_url",
"issue_events_url",
"events_url",
"assignees_url",
"branches_url",
"tags_url",
"blobs_url",
"git_tags_url",
"git_refs_url",
"trees_url",
"statuses_url",
"languages_url",
"stargazers_url",
"contributors_url",
"subscribers_url",
"subscription_url",
"commits_url",
"git_commits_url",
"comments_url",
"issue_comment_url",
"contents_url",
"compare_url",
"merges_url",
"archive_url",
"downloads_url",
"issues_url",
"pulls_url",
"milestones_url",
"notifications_url",
"labels_url",
"releases_url",
"deployments_url",
"created_at",
"updated_at",
"pushed_at",
"git_url",
"ssh_url",
"clone_url",
"svn_url",
"homepage",
"size",
"stargazers_count",
"watchers_count",
"language",
"has_issues",
"has_projects",
"has_downloads",
"has_wiki",
"has_pages",
"has_discussions",
"forks_count",
"mirror_url",
"archived",
"open_issues_count",
"license",
"forks",
"open_issues",
"watchers",
"default_branch",
"topics",
"visibility"
]
},
"sha": {
"type": "string"
},
"user": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer",
"format": "int64"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
}
},
"required": [
"label",
"ref",
"sha",
"user",
"repo"
]
},
"body": {
"type": "string",
"nullable": true
},
"changed_files": {
"type": "integer"
},
"closed_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/json-schema/apis-io-engineering-platform-webhooks-pull-request-5-schema.json