Skip to content

Instantly share code, notes, and snippets.

@jasongaylord
Created September 23, 2020 17:27
Show Gist options
  • Save jasongaylord/9835da3f1a54663de3e89bf93049ef83 to your computer and use it in GitHub Desktop.
Save jasongaylord/9835da3f1a54663de3e89bf93049ef83 to your computer and use it in GitHub Desktop.
GitHub WebHook API Pull Request Schema
{
"type": "object",
"properties": {
"action": {
"type": "string"
},
"number": {
"type": "integer"
},
"pull_request": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"diff_url": {
"type": "string"
},
"patch_url": {
"type": "string"
},
"issue_url": {
"type": "string"
},
"number": {
"type": "integer"
},
"state": {
"type": "string"
},
"locked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
}
}
},
"body": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"closed_at": {},
"merged_at": {},
"merge_commit_sha": {},
"assignee": {},
"assignees": {
"type": "array"
},
"requested_reviewers": {
"type": "array"
},
"requested_teams": {
"type": "array"
},
"labels": {
"type": "array"
},
"milestone": {},
"commits_url": {
"type": "string"
},
"review_comments_url": {
"type": "string"
},
"review_comment_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"head": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
}
}
},
"repo": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"name": {
"type": "string"
},
"full_name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
}
}
},
"html_url": {
"type": "string"
},
"description": {},
"fork": {
"type": "boolean"
},
"url": {
"type": "string"
},
"forks_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"assignees_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"trees_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"stargazers_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"issue_comment_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"archive_url": {
"type": "string"
},
"downloads_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"pulls_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"deployments_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"git_url": {
"type": "string"
},
"ssh_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"homepage": {},
"size": {
"type": "integer"
},
"stargazers_count": {
"type": "integer"
},
"watchers_count": {
"type": "integer"
},
"language": {},
"has_issues": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_downloads": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"mirror_url": {},
"archived": {
"type": "boolean"
},
"disabled": {
"type": "boolean"
},
"open_issues_count": {
"type": "integer"
},
"license": {},
"forks": {
"type": "integer"
},
"open_issues": {
"type": "integer"
},
"watchers": {
"type": "integer"
},
"default_branch": {
"type": "string"
},
"allow_squash_merge": {
"type": "boolean"
},
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"delete_branch_on_merge": {
"type": "boolean"
}
}
}
}
},
"base": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
}
}
},
"repo": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"name": {
"type": "string"
},
"full_name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
}
}
},
"html_url": {
"type": "string"
},
"description": {},
"fork": {
"type": "boolean"
},
"url": {
"type": "string"
},
"forks_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"assignees_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"trees_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"stargazers_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"issue_comment_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"archive_url": {
"type": "string"
},
"downloads_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"pulls_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"deployments_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"git_url": {
"type": "string"
},
"ssh_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"homepage": {},
"size": {
"type": "integer"
},
"stargazers_count": {
"type": "integer"
},
"watchers_count": {
"type": "integer"
},
"language": {},
"has_issues": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_downloads": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"mirror_url": {},
"archived": {
"type": "boolean"
},
"disabled": {
"type": "boolean"
},
"open_issues_count": {
"type": "integer"
},
"license": {},
"forks": {
"type": "integer"
},
"open_issues": {
"type": "integer"
},
"watchers": {
"type": "integer"
},
"default_branch": {
"type": "string"
},
"allow_squash_merge": {
"type": "boolean"
},
"allow_merge_commit": {
"type": "boolean"
},
"allow_rebase_merge": {
"type": "boolean"
},
"delete_branch_on_merge": {
"type": "boolean"
}
}
}
}
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"html": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"issue": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"comments": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"review_comments": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"review_comment": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"commits": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"statuses": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
},
"author_association": {
"type": "string"
},
"draft": {
"type": "boolean"
},
"merged": {
"type": "boolean"
},
"mergeable": {},
"rebaseable": {},
"mergeable_state": {
"type": "string"
},
"merged_by": {},
"comments": {
"type": "integer"
},
"review_comments": {
"type": "integer"
},
"maintainer_can_modify": {
"type": "boolean"
},
"commits": {
"type": "integer"
},
"additions": {
"type": "integer"
},
"deletions": {
"type": "integer"
},
"changed_files": {
"type": "integer"
}
}
},
"repository": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"name": {
"type": "string"
},
"full_name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
}
}
},
"html_url": {
"type": "string"
},
"description": {},
"fork": {
"type": "boolean"
},
"url": {
"type": "string"
},
"forks_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"assignees_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"trees_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"stargazers_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"issue_comment_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"archive_url": {
"type": "string"
},
"downloads_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"pulls_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"deployments_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"pushed_at": {
"type": "string"
},
"git_url": {
"type": "string"
},
"ssh_url": {
"type": "string"
},
"clone_url": {
"type": "string"
},
"svn_url": {
"type": "string"
},
"homepage": {},
"size": {
"type": "integer"
},
"stargazers_count": {
"type": "integer"
},
"watchers_count": {
"type": "integer"
},
"language": {},
"has_issues": {
"type": "boolean"
},
"has_projects": {
"type": "boolean"
},
"has_downloads": {
"type": "boolean"
},
"has_wiki": {
"type": "boolean"
},
"has_pages": {
"type": "boolean"
},
"forks_count": {
"type": "integer"
},
"mirror_url": {},
"archived": {
"type": "boolean"
},
"disabled": {
"type": "boolean"
},
"open_issues_count": {
"type": "integer"
},
"license": {},
"forks": {
"type": "integer"
},
"open_issues": {
"type": "integer"
},
"watchers": {
"type": "integer"
},
"default_branch": {
"type": "string"
}
}
},
"sender": {
"type": "object",
"properties": {
"login": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"type": {
"type": "string"
},
"site_admin": {
"type": "boolean"
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment