- When configuring a webhook, you can use the UI or API to choose which - events will send you payloads. Only subscribing to the specific events you - plan on handling limits the number of HTTP requests to your server. You - can also subscribe to all current and future events. By default, webhooks - are only subscribed to the push event. You can change the list of - subscribed events anytime. -
-- You can create webhooks that subscribe to the events listed on this page. - Each webhook event includes a description of the webhook properties and an - example payload. For more information, see "Creating webhooks." -
-- Webhook payload object common properties -
-- Each webhook event payload also contains properties unique to the event. - You can find the unique properties in the individual event type sections. -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- Most webhook payloads contain an action property that
- contains the specific activity that triggered the event.
- |
-
sender |
- object |
- - The user that triggered the event. This property is included in - every webhook payload. - | -
repository |
- object |
-
- The
- repository
- where the event occurred. Webhook payloads contain the
- repository property when the event occurs from activity
- in a repository.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App. For more information, see "Building GitHub App."
- |
-
- The unique properties for a webhook event are the same properties you'll
- find in the payload
property when using the
- Events API. One exception is the push
event. The
- unique properties of the push
event webhook payload and the
- payload
property in the Events API differ. The webhook
- payload contains more detailed information.
-
- Note: Payloads are capped at 25 MB. If your event
- generates a larger payload, a webhook will not be fired. This may
- happen, for example, on a create
event if many branches or
- tags are pushed at once. We suggest monitoring your payload size to
- ensure delivery.
-
- Delivery headers -
-- HTTP POST payloads that are delivered to your webhook's configured URL - endpoint will contain several special headers: -
- -Header | -Description | -
---|---|
X-GitHub-Event |
- Name of the event that triggered the delivery. | -
X-GitHub-Delivery |
- - A - GUID - to identify the delivery. - | -
X-GitHub-Enterprise-Version |
- - The version of the GitHub Enterprise Server instance that sent the - HTTP POST payload. - | -
X-GitHub-Enterprise-Host |
- - The hostname of the GitHub Enterprise Server instance that sent the - HTTP POST payload. - | -
X-Hub-Signature |
-
- This header is sent if the webhook is configured with a
- secret . This is the HMAC hex digest of the request body, and is generated
- using the SHA-1 hash function and the secret as the
- HMAC key .
- |
-
- Also, the User-Agent
for the requests will have the prefix
- GitHub-Hookshot/
.
-
- Example delivery -
-> POST /payload HTTP/2
-
-> Host: localhost:4567
-> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
-> X-GitHub-Enterprise-Version: 2.15.0
-> X-GitHub-Enterprise-Host: example.com
-> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
-> User-Agent: GitHub-Hookshot/044aadd
-> Content-Type: application/json
-> Content-Length: 6615
-> X-GitHub-Event: issues
-
-> {
-> "action": "opened",
-> "issue": {
-> "url": "http(s)://[hostname]/api/v3/repos/octocat/Hello-World/issues/1347",
-> "number": 1347,
-> ...
-> },
-> "repository" : {
-> "id": 1296269,
-> "full_name": "octocat/Hello-World",
-> "owner": {
-> "login": "octocat",
-> "id": 1,
-> ...
-> },
-> ...
-> },
-> "sender": {
-> "login": "octocat",
-> "id": 1,
-> ...
-> }
-> }
- check_run
-
- Check run activity has occurred. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "check runs" REST API.
-
- Note: The Checks API only looks for pushes in the
- repository where the check suite or check run were created. Pushes to a
- branch in a forked repository are not detected and return an empty
- pull_requests
array and a null
value for
- head_branch
.
-
Availability
--
-
-
- Repository webhooks only receive payloads for the
-
created
andcompleted
event types in a - repository -
- -
- Organization webhooks only receive payloads for the
-
created
andcompleted
event types in - repositories -
- -
- GitHub Apps with the
checks:read
permission receive - payloads for thecreated
andcompleted
events - that occur in the repository where the app is installed. The app must - have thechecks:write
permission to receive the -rerequested
andrequested_action
event types. - Thererequested
andrequested_action
event - type payloads are only sent to the GitHub App being requested. GitHub - Apps with thechecks:write
are automatically subscribed to - this webhook event. -
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action performed. Can be one of:
-
|
-
check_run |
- object |
- - The - check_run. - | -
check_run[status] |
- string |
-
- The current status of the check run. Can be queued ,
- in_progress , or completed .
- |
-
check_run[conclusion] |
- string |
-
- The result of the completed check run. Can be one of
- success , failure , neutral ,
- cancelled , timed_out ,
- action_required or stale . This value will
- be null until the check run has completed .
- |
-
check_run[name] |
- string |
- The name of the check run. | -
check_run[check_suite][id] |
- integer |
- The id of the check suite that this check run is part of. | -
check_run[check_suite][pull_requests] |
- array |
-
- An array of pull requests that match this check suite. A pull
- request matches a check suite if they have the same
- head_sha and head_branch . When the check
- suite's head_branch is in a forked repository it will
- be null and the pull_requests array will
- be empty.
- |
-
requested_action |
- object |
- The action requested by the user. | -
requested_action[identifier] |
- string |
- The integrator reference of the action requested by the user. | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "check_run": {
- "id": 2,
- "node_id": "MDg6Q2hlY2tSdW4y",
- "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "external_id": "",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/runs/2",
- "details_url": "https://octocoders.io",
- "status": "queued",
- "conclusion": null,
- "started_at": "2019-05-15T19:39:04Z",
- "completed_at": null,
- "output": {
- "title": null,
- "summary": null,
- "text": null,
- "annotations_count": 0,
- "annotations_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-runs/2/annotations"
- },
- "name": "Octocoders-linter",
- "check_suite": {
- "id": 9,
- "node_id": "MDEwOkNoZWNrU3VpdGU5",
- "head_branch": "changes",
- "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "status": "queued",
- "conclusion": null,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
- "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
- "after": "14977a7b5485400124827221a04bfb474bcd72d1",
- "pull_requests": [
- {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "id": 2,
- "number": 2,
- "head": {
- "ref": "changes",
- "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "repo": {
- "id": 118,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "name": "Hello-World"
- }
- },
- "base": {
- "ref": "master",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "repo": {
- "id": 118,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "name": "Hello-World"
- }
- }
- }
- ],
- "app": {
- "id": 2,
- "node_id": "MDM6QXBwMg==",
- "owner": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "name": "octocoders-linter",
- "description": "",
- "external_url": "https://octocoders.io",
- "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
- "created_at": "2019-05-15T15:41:35Z",
- "updated_at": "2019-05-15T15:41:35Z",
- "permissions": {
- "administration": "write",
- "checks": "write",
- "contents": "write",
- "deployments": "write",
- "issues": "write",
- "metadata": "read",
- "pages": "write",
- "pull_requests": "write",
- "repository_hooks": "write",
- "repository_projects": "write",
- "vulnerability_alerts": "read",
- "statuses": "write",
- "members": "write",
- "organization_user_blocking": "write",
- "organization_projects": "write",
- "team_discussions": "write",
- "organization_hooks": "write",
- "repository_pre_receive_hooks": "write",
- "organization_pre_receive_hooks": "write"
- },
- "events": [
- "check_run",
- "check_suite",
- "commit_comment",
- "create",
- "delete",
- "deployment",
- "deployment_status",
- "fork",
- "gollum",
- "issues",
- "issue_comment",
- "label",
- "member",
- "membership",
- "milestone",
- "organization",
- "page_build",
- "project",
- "project_card",
- "project_column",
- "public",
- "pull_request",
- "pull_request_review",
- "pull_request_review_comment",
- "push",
- "release",
- "repository",
- "status",
- "team",
- "team_add",
- "watch"
- ]
- },
- "created_at": "2019-05-15T19:38:27Z",
- "updated_at": "2019-05-15T19:38:27Z"
- },
- "app": {
- "id": 2,
- "node_id": "MDM6QXBwMg==",
- "owner": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "name": "octocoders-linter",
- "description": "",
- "external_url": "https://octocoders.io",
- "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
- "created_at": "2019-05-15T15:41:35Z",
- "updated_at": "2019-05-15T15:41:35Z",
- "permissions": {
- "administration": "write",
- "checks": "write",
- "contents": "write",
- "deployments": "write",
- "issues": "write",
- "metadata": "read",
- "pages": "write",
- "pull_requests": "write",
- "repository_hooks": "write",
- "repository_projects": "write",
- "vulnerability_alerts": "read",
- "statuses": "write",
- "members": "write",
- "organization_user_blocking": "write",
- "organization_projects": "write",
- "team_discussions": "write",
- "organization_hooks": "write",
- "repository_pre_receive_hooks": "write",
- "organization_pre_receive_hooks": "write"
- },
- "events": [
- "check_run",
- "check_suite",
- "commit_comment",
- "create",
- "delete",
- "deployment",
- "deployment_status",
- "fork",
- "gollum",
- "issues",
- "issue_comment",
- "label",
- "member",
- "membership",
- "milestone",
- "organization",
- "page_build",
- "project",
- "project_card",
- "project_column",
- "public",
- "pull_request",
- "pull_request_review",
- "pull_request_review_comment",
- "push",
- "release",
- "repository",
- "status",
- "team",
- "team_add",
- "watch"
- ]
- },
- "pull_requests": [
- {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "id": 2,
- "number": 2,
- "head": {
- "ref": "changes",
- "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "repo": {
- "id": 118,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "name": "Hello-World"
- }
- },
- "base": {
- "ref": "master",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "repo": {
- "id": 118,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "name": "Hello-World"
- }
- }
- }
- ]
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:27Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- check_suite
-
- Check suite activity has occurred. The type of activity is specified in
- the action
property of the payload object. For more
- information, see the "check suites" REST API.
-
- Note: The Checks API only looks for pushes in the
- repository where the check suite or check run were created. Pushes to a
- branch in a forked repository are not detected and return an empty
- pull_requests
array and a null
value for
- head_branch
.
-
Availability
--
-
-
- Repository webhooks only receive payloads for the
-
completed
event types in a repository -
- -
- Organization webhooks only receive payloads for the
-
completed
event types in repositories -
- -
- GitHub Apps with the
checks:read
permission receive - payloads for thecreated
andcompleted
events - that occur in the repository where the app is installed. The app must - have thechecks:write
permission to receive the -requested
andrerequested
event types. The -requested
andrerequested
event type payloads - are only sent to the GitHub App being requested. GitHub Apps with the -checks:write
are automatically subscribed to this webhook - event. -
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action performed. Can be:
-
|
-
check_suite |
- object |
- - The - check_suite. - | -
check_suite[head_branch] |
- string |
- The head branch name the changes are on. | -
check_suite[head_sha] |
- string |
- The SHA of the most recent commit for this check suite. | -
check_suite[status] |
- string |
-
- The summary status for all check runs that are part of the check
- suite. Can be requested , in_progress , or
- completed .
- |
-
check_suite[conclusion] |
- string |
-
- The summary conclusion for all check runs that are part of the check
- suite. Can be one of success , failure ,
- neutral , cancelled ,
- timed_out , action_required or
- stale . This value will be null until the
- check run has completed .
- |
-
check_suite[url] |
- string |
- URL that points to the check suite API resource. | -
check_suite[pull_requests] |
- array |
-
- An array of pull requests that match this check suite. A pull
- request matches a check suite if they have the same
- head_sha and head_branch . When the check
- suite's head_branch is in a forked repository it will
- be null and the pull_requests array will
- be empty.
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "completed",
- "check_suite": {
- "id": 9,
- "node_id": "MDEwOkNoZWNrU3VpdGU5",
- "head_branch": "changes",
- "head_sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "status": "completed",
- "conclusion": "success",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9",
- "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
- "after": "14977a7b5485400124827221a04bfb474bcd72d1",
- "pull_requests": [
- {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "id": 2,
- "number": 2,
- "head": {
- "ref": "changes",
- "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "repo": {
- "id": 118,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "name": "Hello-World"
- }
- },
- "base": {
- "ref": "master",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "repo": {
- "id": 118,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "name": "Hello-World"
- }
- }
- }
- ],
- "app": {
- "id": 2,
- "node_id": "MDM6QXBwMg==",
- "owner": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "name": "octocoders-linter",
- "description": "",
- "external_url": "https://octocoders.io",
- "html_url": "https://octocoders.github.io/github-apps/octocoders-linter",
- "created_at": "2019-05-15T15:41:35Z",
- "updated_at": "2019-05-15T15:41:35Z",
- "permissions": {
- "administration": "write",
- "checks": "write",
- "contents": "write",
- "deployments": "write",
- "issues": "write",
- "metadata": "read",
- "pages": "write",
- "pull_requests": "write",
- "repository_hooks": "write",
- "repository_projects": "write",
- "vulnerability_alerts": "read",
- "statuses": "write",
- "members": "write",
- "organization_user_blocking": "write",
- "organization_projects": "write",
- "team_discussions": "write",
- "organization_hooks": "write",
- "repository_pre_receive_hooks": "write",
- "organization_pre_receive_hooks": "write"
- },
- "events": [
- "check_run",
- "check_suite",
- "commit_comment",
- "create",
- "delete",
- "deployment",
- "deployment_status",
- "fork",
- "gollum",
- "issues",
- "issue_comment",
- "label",
- "member",
- "membership",
- "milestone",
- "organization",
- "page_build",
- "project",
- "project_card",
- "project_column",
- "public",
- "pull_request",
- "pull_request_review",
- "pull_request_review_comment",
- "push",
- "release",
- "repository",
- "status",
- "team",
- "team_add",
- "watch"
- ]
- },
- "created_at": "2019-05-15T19:38:27Z",
- "updated_at": "2019-05-15T19:39:09Z",
- "latest_check_runs_count": 1,
- "check_runs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/check-suites/9/check-runs",
- "head_commit": {
- "id": "14977a7b5485400124827221a04bfb474bcd72d1",
- "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
- "message": "Update README.md",
- "timestamp": "2019-05-15T19:38:01Z",
- "author": {
- "name": "Codertocat",
- "email": "Codertocat@Octocoders.io"
- },
- "committer": {
- "name": "Codertocat",
- "email": "Codertocat@Octocoders.io"
- }
- }
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:27Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- - content_reference -
-
- A new content reference is created
. A new content reference
- is created when the body or comment of an issue or pull request includes a
- URL that matches a configured content reference domain. For more
- information, see "Using content attachments" to learn more about content references and attachments.
-
- Webhook events are triggered based on the specificity of the domain you
- register. For example, if you register a subdomain
- (https://subdomain.example.com
) then only URLs for the
- subdomain trigger this event. If you register a domain
- (https://example.com
) then URLs for domain and all subdomains
- trigger this event. See "Create a content attachment" to create a new content attachment.
-
Availability
--
-
-
- GitHub Apps with the
content_references:write
permission -
-
- Webhook payload example -
-{
- "action": "created",
- "content_reference": {
- "id": 17,
- "node_id": "MDE2OkNvbnRlbnRSZWZlcmVuY2UxNjA5",
- "reference": "https://errors.ai/"
- },
- "repository": {
- "id": 145551601,
- "node_id": "MDEwOlJlcG9zaXRvcnkxNDU1NTE2MDE=",
- "name": "hello-world",
- "full_name": "octocoders/hello-world",
- "private": true,
- "owner": {
- "login": "Codertocat",
- "id": 7718702,
- "node_id": "MDQ6VXNlcjc3MTg3MDI=",
- "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": true
- },
- "html_url": "https://github.com/Codertocat/hello-world",
- "description": null,
- "fork": false,
- "url": "https://api.github.com/repos/Codertocat/hello-world",
- "forks_url": "https://api.github.com/repos/Codertocat/hello-world/forks",
- "keys_url": "https://api.github.com/repos/Codertocat/hello-world/keys{/key_id}",
- "collaborators_url": "https://api.github.com/repos/Codertocat/hello-world/collaborators{/collaborator}",
- "teams_url": "https://api.github.com/repos/Codertocat/hello-world/teams",
- "hooks_url": "https://api.github.com/repos/Codertocat/hello-world/hooks",
- "issue_events_url": "https://api.github.com/repos/Codertocat/hello-world/issues/events{/number}",
- "events_url": "https://api.github.com/repos/Codertocat/hello-world/events",
- "assignees_url": "https://api.github.com/repos/Codertocat/hello-world/assignees{/user}",
- "branches_url": "https://api.github.com/repos/Codertocat/hello-world/branches{/branch}",
- "tags_url": "https://api.github.com/repos/Codertocat/hello-world/tags",
- "blobs_url": "https://api.github.com/repos/Codertocat/hello-world/git/blobs{/sha}",
- "git_tags_url": "https://api.github.com/repos/Codertocat/hello-world/git/tags{/sha}",
- "git_refs_url": "https://api.github.com/repos/Codertocat/hello-world/git/refs{/sha}",
- "trees_url": "https://api.github.com/repos/Codertocat/hello-world/git/trees{/sha}",
- "statuses_url": "https://api.github.com/repos/Codertocat/hello-world/statuses/{sha}",
- "languages_url": "https://api.github.com/repos/Codertocat/hello-world/languages",
- "stargazers_url": "https://api.github.com/repos/Codertocat/hello-world/stargazers",
- "contributors_url": "https://api.github.com/repos/Codertocat/hello-world/contributors",
- "subscribers_url": "https://api.github.com/repos/Codertocat/hello-world/subscribers",
- "subscription_url": "https://api.github.com/repos/Codertocat/hello-world/subscription",
- "commits_url": "https://api.github.com/repos/Codertocat/hello-world/commits{/sha}",
- "git_commits_url": "https://api.github.com/repos/Codertocat/hello-world/git/commits{/sha}",
- "comments_url": "https://api.github.com/repos/Codertocat/hello-world/comments{/number}",
- "issue_comment_url": "https://api.github.com/repos/Codertocat/hello-world/issues/comments{/number}",
- "contents_url": "https://api.github.com/repos/Codertocat/hello-world/contents/{+path}",
- "compare_url": "https://api.github.com/repos/Codertocat/hello-world/compare/{base}...{head}",
- "merges_url": "https://api.github.com/repos/Codertocat/hello-world/merges",
- "archive_url": "https://api.github.com/repos/Codertocat/hello-world/{archive_format}{/ref}",
- "downloads_url": "https://api.github.com/repos/Codertocat/hello-world/downloads",
- "issues_url": "https://api.github.com/repos/Codertocat/hello-world/issues{/number}",
- "pulls_url": "https://api.github.com/repos/Codertocat/hello-world/pulls{/number}",
- "milestones_url": "https://api.github.com/repos/Codertocat/hello-world/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/Codertocat/hello-world/notifications{?since,all,participating}",
- "labels_url": "https://api.github.com/repos/Codertocat/hello-world/labels{/name}",
- "releases_url": "https://api.github.com/repos/Codertocat/hello-world/releases{/id}",
- "deployments_url": "https://api.github.com/repos/Codertocat/hello-world/deployments",
- "created_at": "2018-08-21T10:58:58Z",
- "updated_at": "2018-08-21T10:59:01Z",
- "pushed_at": "2018-08-21T10:59:00Z",
- "git_url": "git://github.com/Codertocat/hello-world.git",
- "ssh_url": "git@github.com:Codertocat/hello-world.git",
- "clone_url": "https://github.com/Codertocat/hello-world.git",
- "svn_url": "https://github.com/Codertocat/hello-world",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": false,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "sender": {
- "login": "Codertocat",
- "id": 7718702,
- "node_id": "MDQ6VXNlcjc3MTg3MDI=",
- "avatar_url": "https://avatars1.githubusercontent.com/u/7718702?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": true
- },
- "installation": {
- "id": 371641,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzcxNjQx"
- }
-}
-
- create
-- A Git branch or tag is created. For more information, see the "Git data" REST API. -
-- Note: You will not receive a webhook for this event - when you push more than three tags at once. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
contents
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
ref |
- string |
-
- The
- git ref
- resource.
- |
-
ref_type |
- string |
-
- The type of Git ref object created in the repository. Can be either
- branch or tag .
- |
-
master_branch |
- string |
-
- The name of the repository's default branch (usually
- master ).
- |
-
description |
- string |
- The repository's current description. | -
pusher_type |
- string |
-
- The pusher type for the event. Can be either user or a
- deploy key.
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "ref": "simple-tag",
- "ref_type": "tag",
- "master_branch": "master",
- "description": null,
- "pusher_type": "user",
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:22Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- delete
-- A Git branch or tag is deleted. For more information, see the "Git data" REST API. -
-- Note: You will not receive a webhook for this event - when you delete more than three tags at once. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
contents
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
ref |
- string |
-
- The
- git ref
- resource.
- |
-
ref_type |
- string |
-
- The type of Git ref oject deleted in the repository. Can be
- branch or tag .
- |
-
pusher_type |
- string |
-
- The pusher type for the event. Can be either user or a
- deploy key.
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "ref": "simple-tag",
- "ref_type": "tag",
- "pusher_type": "user",
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- deploy_key
-
- A deploy key is added or removed from a repository. The type of activity
- is specified in the action
property of the payload object.
- For more information, see the "Deploy keys" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action performed. Can be either created or
- deleted .
- |
-
key |
- object |
-
- The
- deploy key
- resource.
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "key": {
- "id": 100,
- "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQConScVc7ouWWgwcjneNnJ4PScDkkwEjuDL5leLIUU5aIg13dH55/f4aqKUSvfcLUOKJ0a8073tFqMbR9rfvLAhLGeStKxmYApJXpzVkphauu7kfNW8kQNi1fI4kmHyOpQ+dKtoonzjZAT4L9AV3FlVTOfRq3U8wJ2RPwU+4EtOpMKUF+wcoDJ5ONlKBOW6uAeBt/guBiu6r3awDClDGRo4Q2YCmMceiAyoiuXcr2mFNSyzTqU1f20fftFwucV/VqnxlJjZvZ/zhlfB+v+UgQN11pJJ5vChZ7bzyRtIRRsjxbTReyWxqVZ5hEle5sm1oAR97abW9zTWfwIABgClKo+z",
- "url": "https://api.github.com/repos/Codertocat/Hello-World/keys/100",
- "title": "hey-its-a-deploy-key",
- "verified": true,
- "created_at": "2019-04-02T17:37:07Z",
- "read_only": true
- },
- "repository": {
- "id": 135493233,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "owner": {
- "login": "Codertocat",
- "id": 21031067,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "private": false,
- "html_url": "https://github.com/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://api.github.com/repos/Codertocat/Hello-World",
- "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
- "created_at": "2018-05-30T20:18:04Z",
- "updated_at": "2018-05-30T20:18:50Z",
- "pushed_at": "2018-05-30T20:18:48Z",
- "git_url": "git://github.com/Codertocat/Hello-World.git",
- "ssh_url": "git@github.com:Codertocat/Hello-World.git",
- "clone_url": "https://github.com/Codertocat/Hello-World.git",
- "svn_url": "https://github.com/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "open_issues_count": 1,
- "license": null,
- "forks": 0,
- "open_issues": 1,
- "watchers": 0,
- "default_branch": "master"
- },
- "sender": {
- "login": "Codertocat",
- "id": 21031067,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- deployment
-
- A deployment is created. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "deployment" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
deployments
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
- The action performed. Can be created . |
-
deployment |
- object |
- - The - deployment. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "deployment": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
- "id": 2,
- "node_id": "MDEwOkRlcGxveW1lbnQy",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "ref": "master",
- "task": "deploy",
- "payload": {},
- "original_environment": "production",
- "environment": "production",
- "description": null,
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "created_at": "2019-05-15T19:38:20Z",
- "updated_at": "2019-05-15T19:38:20Z",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
- "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:19Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- - deployment_status -
-
- A deployment is created. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "deployment statuses" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
deployments
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
- The action performed. Can be created . |
-
deployment_status |
- object |
- - The - deployment status. - | -
deployment_status["state"] |
- string |
-
- The new state. Can be pending , success ,
- failure , or error .
- |
-
deployment_status["target_url"] |
- string |
- The optional link added to the status. | -
deployment_status["description"] |
- string |
- The optional human-readable description added to the status. | -
deployment |
- object |
- - The - deployment - that this status is associated with. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "deployment_status": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses/2",
- "id": 2,
- "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMy",
- "state": "success",
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "description": "",
- "environment": "production",
- "target_url": "",
- "created_at": "2019-05-15T19:38:21Z",
- "updated_at": "2019-05-15T19:38:21Z",
- "deployment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
- "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
- },
- "deployment": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2",
- "id": 2,
- "node_id": "MDEwOkRlcGxveW1lbnQy",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "ref": "master",
- "task": "deploy",
- "payload": {},
- "original_environment": "production",
- "environment": "production",
- "description": null,
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "created_at": "2019-05-15T19:38:20Z",
- "updated_at": "2019-05-15T19:38:21Z",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments/2/statuses",
- "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:19Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- enterprise
-- A site or repository administrator enables or disables anonymous Git read - access. See "Allowing admins to enable anonymous Git read access to public - repositories" for more details. This event is not available in the Events API. -
-Availability
--
-
- - GitHub Enterprise webhooks. For more information, "Global webhooks." - -
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action performed. Can be
- anonymous_access_enabled or
- anonymous_access_disabled .
- |
-
- Webhook payload example -
-{
- "action": "anonymous_access_enabled",
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://avatars.octocoders.github.io/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": true
- }
-}
-
- fork
-- A user forks a repository. For more information, see the "forks" REST API. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
contents
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
forkee |
- object |
-
- The created
- repository
- resource.
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "forkee": {
- "id": 120,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
- "name": "Hello-World",
- "full_name": "Octocoders/Hello-World",
- "private": false,
- "owner": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
- "description": null,
- "fork": true,
- "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
- "created_at": "2019-05-15T19:38:10Z",
- "updated_at": "2019-05-15T19:38:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": false,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": false,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 0,
- "license": null,
- "forks": 0,
- "open_issues": 0,
- "watchers": 0,
- "default_branch": "master",
- "public": true
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- - github_app_authorization -
-- When someone revokes their authorization of a GitHub App, this event - occurs. A GitHub App receives this webhook by default and cannot - unsubscribe from this event. -
-
- Anyone can revoke their authorization of a GitHub App from their
- GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the
- GitHub App. You should program your GitHub App so that when it receives
- this webhook, it stops calling the API on behalf of the person who revoked
- the token. If your GitHub App continues to use a revoked access token, it
- will receive the 401 Bad Credentials
error. For details about
- user-to-server requests, which require GitHub App authorization, see "Identifying and authorizing users for GitHub Apps."
-
Availability
--
-
- GitHub Apps -
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
- The action performed. Can be revoked . |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "revoked",
- "sender": {
- "login": "octocat",
- "id": 1,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://github.com/images/error/octocat_happy.gif",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octocat",
- "html_url": "https://github.com/octocat",
- "followers_url": "https://api.github.com/users/octocat/followers",
- "following_url": "https://api.github.com/users/octocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
- "organizations_url": "https://api.github.com/users/octocat/orgs",
- "repos_url": "https://api.github.com/users/octocat/repos",
- "events_url": "https://api.github.com/users/octocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- gollum
-- A wiki page is created or updated. For more information, see the "About wikis". -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
contents
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
pages |
- array |
- The pages that were updated. | -
pages[][page_name] |
- string |
- The name of the page. | -
pages[][title] |
- string |
- The current page title. | -
pages[][action] |
- string |
-
- The action that was performed on the page. Can be
- created or edited .
- |
-
pages[][sha] |
- string |
- The latest commit SHA of the page. | -
pages[][html_url] |
- string |
- Points to the HTML wiki page. | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "pages": [
- {
- "page_name": "Home",
- "title": "Home",
- "summary": null,
- "action": "edited",
- "sha": "4bbb6df16cb5ce1818602bf634e94ebdac7ae385",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/wiki/Home"
- }
- ],
- "repository": {
- "id": 122,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjI=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://avatars.octocoders.github.io/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "private": false,
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2018-10-04T18:29:19Z",
- "updated_at": "2018-10-04T18:29:21Z",
- "pushed_at": "2018-10-04T18:29:59Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "open_issues_count": 0,
- "license": null,
- "forks": 0,
- "open_issues": 0,
- "watchers": 0,
- "default_branch": "master"
- },
- "sender": {
- "login": "rachmari",
- "id": 3,
- "node_id": "MDQ6VXNlcjM=",
- "avatar_url": "https://avatars.octocoders.github.io/u/3?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/rachmari",
- "html_url": "https://octocoders.github.io/rachmari",
- "followers_url": "https://octocoders.github.io/api/v3/users/rachmari/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/rachmari/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/rachmari/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/rachmari/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/rachmari/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/rachmari/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/rachmari/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/rachmari/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/rachmari/received_events",
- "type": "User",
- "site_admin": true
- }
-}
-
- installation
-
- Activity related to a GitHub App installation. The type of activity is
- specified in the action
property of the payload object. For
- more information, see the "GitHub App installation" REST API.
-
- Note: This event replaces the deprecated
- integration_installation
event.
-
Availability
--
-
- GitHub Apps -
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of:
-
|
-
repositories |
- array |
- - An array of repository objects that the installation can access. - | -
installation |
- object |
- The GitHub App installation. | -
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "deleted",
- "installation": {
- "id": 5,
- "account": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
- "gravatar_id": "",
- "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
- "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
- "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
- "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
- "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
- "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repository_selection": "selected",
- "access_tokens_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/app/installations/5/access_tokens",
- "repositories_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/installation/repositories",
- "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/settings/installations/5",
- "app_id": 2,
- "target_id": 4,
- "target_type": "User",
- "permissions": {
- "administration": "write",
- "checks": "write",
- "contents": "write",
- "deployments": "write",
- "issues": "write",
- "pages": "write",
- "pull_requests": "write",
- "repository_hooks": "write",
- "repository_projects": "write",
- "statuses": "write",
- "repository_pre_receive_hooks": "write",
- "metadata": "read",
- "vulnerability_alerts": "read"
- },
- "events": [
- "check_run",
- "check_suite",
- "commit_comment",
- "create",
- "delete",
- "deployment",
- "deployment_status",
- "fork",
- "gollum",
- "issues",
- "issue_comment",
- "label",
- "member",
- "membership",
- "milestone",
- "organization",
- "page_build",
- "project",
- "project_card",
- "project_column",
- "public",
- "pull_request",
- "pull_request_review",
- "pull_request_review_comment",
- "push",
- "release",
- "repository",
- "status",
- "team",
- "team_add",
- "watch"
- ],
- "created_at": "2019-05-15T19:37:38.000Z",
- "updated_at": "2019-05-15T19:37:38.000Z",
- "single_file_name": null
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/avatars/u/4?",
- "gravatar_id": "",
- "url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat",
- "html_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/Codertocat",
- "followers_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/followers",
- "following_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/orgs",
- "repos_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/repos",
- "events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "http://rachmari-0a7d40112fe15292b.ghe-test.net/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- - installation_repositories -
-
- Activity related to repositories being added to a GitHub App installation.
- The type of activity is specified in the action
property of
- the payload object. For more information, see the "GitHub App installation" REST API.
-
- Note: This event replaces the deprecated
- integration_installation_repositories
event.
-
Availability
--
-
- GitHub Apps -
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be either added or
- removed .
- |
-
repository_selection |
- string |
-
- The choice of repositories the installation is on. Can be either
- selected or all .
- |
-
repositories_added |
- array |
- - An array of repository objects, which were added to the - installation. - | -
repositories_removed |
- array |
- - An array of repository objects, which were removed from the - installation. - | -
installation |
- object |
- The GitHub App installation. | -
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "added",
- "installation": {
- "id": 5,
- "account": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repository_selection": "selected",
- "access_tokens_url": "https://octocoders.github.io/api/v3/app/installations/5/access_tokens",
- "repositories_url": "https://octocoders.github.io/api/v3/installation/repositories",
- "html_url": "https://octocoders.github.io/settings/installations/5",
- "app_id": 2,
- "target_id": 4,
- "target_type": "User",
- "permissions": {
- "administration": "write",
- "repository_pre_receive_hooks": "write",
- "statuses": "write",
- "repository_projects": "write",
- "repository_hooks": "write",
- "pull_requests": "write",
- "pages": "write",
- "issues": "write",
- "deployments": "write",
- "contents": "write",
- "checks": "write",
- "vulnerability_alerts": "read",
- "metadata": "read"
- },
- "events": [
- "check_run",
- "check_suite",
- "commit_comment",
- "create",
- "delete",
- "deployment",
- "deployment_status",
- "fork",
- "gollum",
- "issues",
- "issue_comment",
- "label",
- "member",
- "membership",
- "milestone",
- "organization",
- "page_build",
- "project",
- "project_card",
- "project_column",
- "public",
- "pull_request",
- "pull_request_review",
- "pull_request_review_comment",
- "push",
- "release",
- "repository",
- "status",
- "team",
- "team_add",
- "watch"
- ],
- "created_at": 1557949058,
- "updated_at": 1557949058,
- "single_file_name": null
- },
- "repository_selection": "selected",
- "repositories_added": [
- {
- "id": 119,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTk=",
- "name": "Space",
- "full_name": "Codertocat/Space",
- "private": false
- }
- ],
- "repositories_removed": [],
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- issue_comment
-
- Activity related to an issue or pull request comment. The type of activity
- is specified in the action
property of the payload object.
- For more information, see the "issue comments" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
issues
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed on the comment. Can be one of
- created , edited , or deleted .
- |
-
changes |
- object |
-
- The changes to the comment if the action was edited .
- |
-
changes[body][from] |
- string |
-
- The previous version of the body if the action was
- edited .
- |
-
issue |
- object |
- - The - issue - the comment belongs to. - | -
comment |
- object |
- - The - comment - itself. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "issue": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
- "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
- "id": 10,
- "node_id": "MDU6SXNzdWUxMA==",
- "number": 1,
- "title": "Spelling error in the README file",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "labels": [
- {
- "id": 941,
- "node_id": "MDU6TGFiZWw5NDE=",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
- "name": "bug",
- "color": "d73a4a",
- "default": true
- }
- ],
- "state": "open",
- "locked": false,
- "assignee": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "assignees": [
- {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
- ],
- "milestone": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
- "id": 2,
- "node_id": "MDk6TWlsZXN0b25lMg==",
- "number": 1,
- "title": "v1.0",
- "description": "Add new space flight simulator",
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "open_issues": 1,
- "closed_issues": 0,
- "state": "closed",
- "created_at": "2019-05-15T19:37:52Z",
- "updated_at": "2019-05-15T19:37:53Z",
- "due_on": "2019-05-23T00:00:00Z",
- "closed_at": "2019-05-15T19:37:53Z"
- },
- "comments": 0,
- "created_at": "2019-05-15T19:37:53Z",
- "updated_at": "2019-05-15T19:37:55Z",
- "closed_at": null,
- "author_association": "OWNER",
- "body": "It looks like you accidently spelled 'commit' with two 't's."
- },
- "comment": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments/2",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1#issuecomment-2",
- "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
- "id": 2,
- "node_id": "MDEyOklzc3VlQ29tbWVudDI=",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "created_at": "2019-05-15T19:37:55Z",
- "updated_at": "2019-05-15T19:37:55Z",
- "author_association": "OWNER",
- "body": "You are totally right! I'll get this fixed right away."
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:37:50Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 1,
- "license": null,
- "forks": 0,
- "open_issues": 1,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- issues
-
- Activity related to an issue. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "issues" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
issues
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of opened ,
- edited , deleted , pinned ,
- unpinned , closed , reopened ,
- assigned , unassigned ,
- labeled , unlabeled , locked ,
- unlocked , transferred ,
- milestoned , or demilestoned .
- |
-
issue |
- object |
- - The - issue - itself. - | -
changes |
- object |
-
- The changes to the issue if the action was edited .
- |
-
changes[title][from] |
- string |
-
- The previous version of the title if the action was
- edited .
- |
-
changes[body][from] |
- string |
-
- The previous version of the body if the action was
- edited .
- |
-
assignee |
- object |
- - The optional user who was assigned or unassigned from the issue. - | -
label |
- object |
- The optional label that was added or removed from the issue. | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example when someone edits an issue -
-{
- "action": "edited",
- "issue": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1",
- "repository_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/labels{/name}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/comments",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/1/events",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/issues/1",
- "id": 10,
- "node_id": "MDU6SXNzdWUxMA==",
- "number": 1,
- "title": "Spelling error in the README file",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "labels": [
- {
- "id": 941,
- "node_id": "MDU6TGFiZWw5NDE=",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/bug",
- "name": "bug",
- "color": "d73a4a",
- "default": true
- }
- ],
- "state": "open",
- "locked": false,
- "assignee": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "assignees": [
- {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
- ],
- "milestone": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
- "id": 2,
- "node_id": "MDk6TWlsZXN0b25lMg==",
- "number": 1,
- "title": "v1.0",
- "description": "Add new space flight simulator",
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "open_issues": 1,
- "closed_issues": 0,
- "state": "closed",
- "created_at": "2019-05-15T19:37:52Z",
- "updated_at": "2019-05-15T19:37:53Z",
- "due_on": "2019-05-23T00:00:00Z",
- "closed_at": "2019-05-15T19:37:53Z"
- },
- "comments": 0,
- "created_at": "2019-05-15T19:37:53Z",
- "updated_at": "2019-05-15T19:37:54Z",
- "closed_at": null,
- "author_association": "OWNER",
- "body": "It looks like you accidently spelled 'commit' with two 't's."
- },
- "changes": {},
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:37:50Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 1,
- "license": null,
- "forks": 0,
- "open_issues": 1,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- label
-
- Activity related to a label. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "labels" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
metadata
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be created ,
- edited , or deleted .
- |
-
label |
- object |
- The label that was added. | -
changes |
- object |
-
- The changes to the label if the action was edited .
- |
-
changes[name][from] |
- string |
-
- The previous version of the name if the action was
- edited .
- |
-
changes[color][from] |
- string |
-
- The previous version of the color if the action was
- edited .
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "deleted",
- "label": {
- "id": 965,
- "node_id": "MDU6TGFiZWw5NjU=",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels/:bug:%20Bugfix",
- "name": ":bug: Bugfix",
- "color": "cceeaa",
- "default": false
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:25Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- member
-
- Activity related to repository collaborators. The type of activity is
- specified in the action
property of the payload object. For
- more information, see the "collaborators" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
members
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of:
-
|
-
member |
- object |
- - The - user - that was added. - | -
changes |
- object |
-
- The changes to the collaborator permissions if the action was
- edited .
- |
-
changes[old_permission][from] |
- string |
-
- The previous permissions of the collaborator if the action was
- edited .
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "added",
- "member": {
- "login": "Hacktocat",
- "id": 5,
- "node_id": "MDQ6VXNlcjU=",
- "avatar_url": "https://octocoders.github.io/avatars/u/5?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
- "html_url": "https://octocoders.github.io/Hacktocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- membership
-
- Activity related to team membership. The type of activity is specified in
- the action
property of the payload object. For more
- information, see the "team members" REST API.
-
Availability
--
-
- Organization webhooks -
- GitHub Apps with the
members
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be added or
- removed .
- |
-
scope |
- string |
-
- The scope of the membership. Currently, can only be
- team .
- |
-
member |
- object |
- - The - user - that was added or removed. - | -
team |
- object |
- - The - team - for the membership. - | -
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "removed",
- "scope": "team",
- "member": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "team": {
- "name": "github",
- "id": 3,
- "node_id": "MDQ6VGVhbTM=",
- "slug": "github",
- "description": "Open-source team",
- "privacy": "secret",
- "url": "https://octocoders.github.io/api/v3/teams/3",
- "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
- "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
- "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
- "permission": "pull"
- },
- "organization": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
- "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
- "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
- "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
- "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
- "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "description": ""
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- }
-}
-
- meta
-- The webhook this event is configured on was deleted. This event will only - listen for changes to the particular hook the event is installed on. - Therefore, it must be selected for each hook that you'd like to receive - meta events for. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
- The action performed. Can be deleted . |
-
hook_id |
- integer |
- The id of the modified webhook. | -
hook |
- object |
- - The modified webhook. This will contain different keys based on the - type of webhook it is: repository, organization, business, app, or - GitHub Marketplace. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "deleted",
- "hook_id": 101047067,
- "hook": {
- "type": "Repository",
- "id": 101047067,
- "name": "web",
- "active": true,
- "events": [
- "meta"
- ],
- "config": {
- "content_type": "json",
- "insecure_ssl": "0",
- "url": "http://example.com/hook"
- },
- "updated_at": "2019-04-10T03:57:12Z",
- "created_at": "2019-04-10T03:57:12Z"
- },
- "repository": {
- "id": 135493233,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMzU0OTMyMzM=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "owner": {
- "login": "Codertocat",
- "id": 21031067,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "private": false,
- "html_url": "https://github.com/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://api.github.com/repos/Codertocat/Hello-World",
- "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
- "created_at": "2018-05-30T20:18:04Z",
- "updated_at": "2018-05-30T20:18:50Z",
- "pushed_at": "2018-05-30T20:18:48Z",
- "git_url": "git://github.com/Codertocat/Hello-World.git",
- "ssh_url": "git@github.com:Codertocat/Hello-World.git",
- "clone_url": "https://github.com/Codertocat/Hello-World.git",
- "svn_url": "https://github.com/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "open_issues_count": 1,
- "license": null,
- "forks": 0,
- "open_issues": 1,
- "watchers": 0,
- "default_branch": "master"
- },
- "sender": {
- "login": "Codertocat",
- "id": 21031067,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- milestone
-
- Activity related to milestones. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "milestones" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
pull_requests
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of created ,
- closed , opened , edited , or
- deleted .
- |
-
milestone |
- object |
- The milestone itself. | -
changes |
- object |
-
- The changes to the milestone if the action was edited .
- |
-
changes[description][from] |
- string |
-
- The previous version of the description if the action was
- edited .
- |
-
changes[due_on][from] |
- string |
-
- The previous version of the due date if the action was
- edited .
- |
-
changes[title][from] |
- string |
-
- The previous version of the title if the action was
- edited .
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "milestone": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/milestone/1",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones/1/labels",
- "id": 2,
- "node_id": "MDk6TWlsZXN0b25lMg==",
- "number": 1,
- "title": "v1.0",
- "description": "Add new space flight simulator",
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "open_issues": 0,
- "closed_issues": 0,
- "state": "open",
- "created_at": "2019-05-15T19:37:52Z",
- "updated_at": "2019-05-15T19:37:52Z",
- "due_on": "2019-05-23T00:00:00Z",
- "closed_at": null
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:37:50Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 0,
- "license": null,
- "forks": 0,
- "open_issues": 0,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- organization
-
- Activity related to an organization and its members. The type of activity
- is specified in the action
property of the payload object.
- For more information, see the "organizations" REST API.
-
Availability
--
-
-
- GitHub Enterprise webhooks only receive
created
and -deleted
events. For more information, "Global webhooks. -
- -
- Organization webhooks only receive the
deleted
, -added
,removed
,renamed
, and -invited
events -
- - GitHub Apps with the
members
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of: created ,
- deleted , renamed ,
- member_added , member_removed , or
- member_invited .
- |
-
invitation |
- object |
-
- The invitation for the user or email if the action is
- member_invited .
- |
-
membership |
- object |
-
- The membership between the user and the organization. Not present
- when the action is member_invited .
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "member_added",
- "membership": {
- "url": "https://octocoders.github.io/api/v3/orgs/Octocoders/memberships/Hacktocat",
- "state": "active",
- "role": "member",
- "organization_url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
- "user": {
- "login": "Hacktocat",
- "id": 5,
- "node_id": "MDQ6VXNlcjU=",
- "avatar_url": "https://octocoders.github.io/avatars/u/5?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Hacktocat",
- "html_url": "https://octocoders.github.io/Hacktocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Hacktocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Hacktocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Hacktocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Hacktocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Hacktocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Hacktocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Hacktocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Hacktocat/received_events",
- "type": "User",
- "site_admin": false
- }
- },
- "organization": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
- "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
- "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
- "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
- "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
- "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "description": ""
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- page_build
-
- Represents an attempted build of a GitHub Pages site, whether successful
- or not. A push to a GitHub Pages enabled branch (gh-pages
for
- project pages, the default branch for user and organization pages)
- triggers this event.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
pages
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
id |
- integer |
- The unique identifier of the page build. | -
build |
- object |
- - The - List GitHub Pages builds - itself. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "id": 7,
- "build": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pages/builds/7",
- "status": "built",
- "error": {
- "message": null
- },
- "pusher": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "commit": "3648135c2986115284ae152d90459473b15fd19c",
- "duration": 6917,
- "created_at": "2019-05-15T19:38:15Z",
- "updated_at": "2019-05-15T19:38:22Z"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:19Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- ping
-
- When you create a new webhook, we'll send you a simple
- ping
event to let you know you've set up the webhook
- correctly. This event isn't stored so it isn't retrievable via the
- Events API
- endpoint.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
-
- GitHub Apps receive a ping event with an
app_id
used to - register the app -
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
zen |
- string |
- Random string of GitHub zen. | -
hook_id |
- integer |
- The ID of the webhook that triggered the ping. | -
hook |
- object |
- - The - webhook configuration. - | -
hook[app_id] |
- integer |
-
- When you register a new GitHub App, GitHub Enterprise Server sends a
- ping event to the webhook URL you specified during
- registration. The event contains the app_id , which is
- required for
- authenticating
- an app.
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "zen": "Non-blocking is better than blocking.",
- "hook_id": 30,
- "hook": {
- "type": "Repository",
- "id": 30,
- "name": "web",
- "active": true,
- "events": [
- "*"
- ],
- "config": {
- "content_type": "json",
- "url": "https://smee.io/YEbF2t8kjvPAn7Ck",
- "insecure_ssl": "0"
- },
- "updated_at": "2019-05-15T19:38:17Z",
- "created_at": "2019-05-15T19:38:17Z",
- "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30",
- "test_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/test",
- "ping_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks/30/pings",
- "last_response": {
- "code": null,
- "status": "unused",
- "message": null
- }
- },
- "repository": {
- "id": 120,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
- "name": "Hello-World",
- "full_name": "Octocoders/Hello-World",
- "private": false,
- "owner": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
- "description": null,
- "fork": true,
- "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
- "created_at": "2019-05-15T19:38:10Z",
- "updated_at": "2019-05-15T19:38:14Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": false,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": false,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 0,
- "license": null,
- "forks": 0,
- "open_issues": 0,
- "watchers": 0,
- "default_branch": "master"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- project_card
-
- Activity related to project cards. The type of activity is specified in
- the action
property of the payload object. For more
- information, see the "project cards" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
-
- GitHub Apps with the
repository_projects
or -organization_projects
permission -
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action performed on the project card. Can be
- created , edited , moved ,
- converted , or deleted .
- |
-
changes |
- object |
-
- The changes to the project card if the action was
- edited or converted .
- |
-
changes[note][from] |
- string |
-
- The previous version of the note if the action was
- edited or converted .
- |
-
after_id |
- integer |
-
- The id of the card that this card now follows if the action was
- "moved". Will be null if it is the first card in a
- column.
- |
-
project_card |
- object |
- - The - project card - itself. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "project_card": {
- "url": "https://octocoders.github.io/api/v3/projects/columns/cards/8",
- "project_url": "https://octocoders.github.io/api/v3/projects/6",
- "column_url": "https://octocoders.github.io/api/v3/projects/columns/8",
- "column_id": 8,
- "id": 8,
- "node_id": "MDExOlByb2plY3RDYXJkOA==",
- "note": "Work that can be completed in one hour or less.",
- "archived": false,
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "created_at": "2019-05-15T19:39:01Z",
- "updated_at": "2019-05-15T19:39:01Z"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:27Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- project_column
-
- Activity related to columns in a project board. The type of activity is
- specified in the action
property of the payload object. For
- more information, see the "project columns" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
-
- GitHub Apps with the
repository_projects
or -organization_projects
permission -
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed on the project column. Can be one of
- created , edited , moved or
- deleted .
- |
-
changes |
- object |
-
- The changes to the project column if the action was
- edited .
- |
-
changes[name][from] |
- string |
-
- The previous version of the name if the action was
- edited .
- |
-
after_id |
- integer |
-
- The id of the column that this column now follows if the action was
- "moved". Will be null if it is the first column in a
- project.
- |
-
project_column |
- object |
- - The - project column - itself. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "project_column": {
- "url": "https://octocoders.github.io/api/v3/projects/columns/8",
- "project_url": "https://octocoders.github.io/api/v3/projects/6",
- "cards_url": "https://octocoders.github.io/api/v3/projects/columns/8/cards",
- "id": 8,
- "node_id": "MDEzOlByb2plY3RDb2x1bW44",
- "name": "Small bugfixes",
- "created_at": "2019-05-15T19:39:01Z",
- "updated_at": "2019-05-15T19:39:01Z"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:27Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- project
-
- Activity related to project boards. The type of activity is specified in
- the action
property of the payload object. For more
- information, see the "projects" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
-
- GitHub Apps with the
repository_projects
or -organization_projects
permission -
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed on the project. Can be one of
- created , edited , closed ,
- reopened , or deleted .
- |
-
changes |
- object |
-
- The changes to the project if the action was edited .
- |
-
changes[name][from] |
- string |
-
- The previous version of the name if the action was
- edited .
- |
-
changes[body][from] |
- string |
-
- The previous version of the body if the action was
- edited .
- |
-
project |
- object |
- - The - project - itself. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "project": {
- "owner_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "url": "https://octocoders.github.io/api/v3/projects/6",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/projects/1",
- "columns_url": "https://octocoders.github.io/api/v3/projects/6/columns",
- "id": 6,
- "node_id": "MDc6UHJvamVjdDY=",
- "name": "Space 2.0",
- "body": "Project tasks for a trip to Space",
- "number": 1,
- "state": "open",
- "creator": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "created_at": "2019-05-15T19:38:27Z",
- "updated_at": "2019-05-15T19:38:27Z"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:27Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- public
-- When a private repository is made public. Without a doubt: the best GitHub - Enterprise Server event. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
metadata
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:25Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- pull_request
-
- Activity related to pull requests. The type of activity is specified in
- the action
property of the payload object. For more
- information, see the "pull requests" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
pull_requests
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of:
-
|
-
number |
- integer |
- The pull request number. | -
changes |
- object |
-
- The changes to the comment if the action was edited .
- |
-
changes[title][from] |
- string |
-
- The previous version of the title if the action was
- edited .
- |
-
changes[body][from] |
- string |
-
- The previous version of the body if the action was
- edited .
- |
-
pull_request |
- object |
- - The - pull request - itself. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-
- Deliveries for review_requested
and
- review_request_removed
events will have an additional field
- called requested_reviewer
.
-
{
- "action": "opened",
- "number": 2,
- "pull_request": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "id": 2,
- "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
- "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
- "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
- "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
- "number": 2,
- "state": "open",
- "locked": false,
- "title": "Update the README with new information.",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "This is a pretty simple change that we need to pull into master.",
- "created_at": "2019-05-15T19:38:02Z",
- "updated_at": "2019-05-15T19:38:02Z",
- "closed_at": null,
- "merged_at": null,
- "merge_commit_sha": null,
- "assignee": null,
- "assignees": [],
- "requested_reviewers": [],
- "requested_teams": [],
- "labels": [],
- "milestone": null,
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
- "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
- "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
- "head": {
- "label": "Codertocat:changes",
- "ref": "changes",
- "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repo": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- }
- },
- "base": {
- "label": "Codertocat:master",
- "ref": "master",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repo": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- }
- },
- "_links": {
- "self": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
- },
- "html": {
- "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
- },
- "issue": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
- },
- "comments": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
- },
- "review_comments": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
- },
- "review_comment": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
- },
- "commits": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
- },
- "statuses": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
- }
- },
- "author_association": "OWNER",
- "draft": false,
- "merged": false,
- "mergeable": null,
- "rebaseable": null,
- "mergeable_state": "unknown",
- "merged_by": null,
- "comments": 0,
- "review_comments": 0,
- "maintainer_can_modify": false,
- "commits": 1,
- "additions": 1,
- "deletions": 1,
- "changed_files": 1
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- - pull_request_review -
-
- Activity related to pull request reviews. The type of activity is
- specified in the action
property of the payload object. For
- more information, see the "pull request reviews" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
pull_requests
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of:
-
|
-
pull_request |
- object |
- - The - pull request - the review pertains to. - | -
review |
- object |
- The review that was affected. | -
changes[body][from] |
- string |
-
- The previous version of the body if the action was
- edited .
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "submitted",
- "review": {
- "id": 2,
- "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3Mg==",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": null,
- "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
- "submitted_at": "2019-05-15T19:38:08Z",
- "state": "commented",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2",
- "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "author_association": "OWNER",
- "_links": {
- "html": {
- "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#pullrequestreview-2"
- },
- "pull_request": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
- }
- }
- },
- "pull_request": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "id": 2,
- "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
- "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
- "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
- "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
- "number": 2,
- "state": "open",
- "locked": false,
- "title": "Update the README with new information.",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "This is a pretty simple change that we need to pull into master.",
- "created_at": "2019-05-15T19:38:02Z",
- "updated_at": "2019-05-15T19:38:08Z",
- "closed_at": null,
- "merged_at": null,
- "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
- "assignee": null,
- "assignees": [],
- "requested_reviewers": [],
- "requested_teams": [],
- "labels": [],
- "milestone": null,
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
- "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
- "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
- "head": {
- "label": "Codertocat:changes",
- "ref": "changes",
- "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repo": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- }
- },
- "base": {
- "label": "Codertocat:master",
- "ref": "master",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repo": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- }
- },
- "_links": {
- "self": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
- },
- "html": {
- "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
- },
- "issue": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
- },
- "comments": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
- },
- "review_comments": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
- },
- "review_comment": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
- },
- "commits": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
- },
- "statuses": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
- }
- },
- "author_association": "OWNER"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- - pull_request_review_comment -
-
- Activity related to pull request review comments in the pull request's
- unified diff. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "pull request review comments" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
pull_requests
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed on the comment. Can be one of
- created , edited , or deleted .
- |
-
changes |
- object |
-
- The changes to the comment if the action was edited .
- |
-
changes[body][from] |
- string |
-
- The previous version of the body if the action was
- edited .
- |
-
pull_request |
- object |
- - The - pull request - the comment belongs to. - | -
comment |
- object |
- - The - comment - itself. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "comment": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2",
- "pull_request_review_id": 2,
- "id": 2,
- "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI=",
- "diff_hunk": "@@ -1 +1 @@\n-# Hello-World",
- "path": "README.md",
- "position": 1,
- "original_position": 1,
- "commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
- "original_commit_id": "14977a7b5485400124827221a04bfb474bcd72d1",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "Maybe you should use more emoji on this line.",
- "created_at": "2019-05-15T19:38:07Z",
- "updated_at": "2019-05-15T19:38:08Z",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2",
- "pull_request_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "author_association": "OWNER",
- "_links": {
- "self": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments/2"
- },
- "html": {
- "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2#discussion_r2"
- },
- "pull_request": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
- }
- }
- },
- "pull_request": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2",
- "id": 2,
- "node_id": "MDExOlB1bGxSZXF1ZXN0Mg==",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2",
- "diff_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.diff",
- "patch_url": "https://octocoders.github.io/Codertocat/Hello-World/pull/2.patch",
- "issue_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2",
- "number": 2,
- "state": "open",
- "locked": false,
- "title": "Update the README with new information.",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "body": "This is a pretty simple change that we need to pull into master.",
- "created_at": "2019-05-15T19:38:02Z",
- "updated_at": "2019-05-15T19:38:08Z",
- "closed_at": null,
- "merged_at": null,
- "merge_commit_sha": "e67e14475991deeb61cc1999c3bf9db333ac0d5f",
- "assignee": null,
- "assignees": [],
- "requested_reviewers": [],
- "requested_teams": [],
- "labels": [],
- "milestone": null,
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits",
- "review_comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments",
- "review_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1",
- "head": {
- "label": "Codertocat:changes",
- "ref": "changes",
- "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repo": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- }
- },
- "base": {
- "label": "Codertocat:master",
- "ref": "master",
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "user": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "repo": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- }
- },
- "_links": {
- "self": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2"
- },
- "html": {
- "href": "https://octocoders.github.io/Codertocat/Hello-World/pull/2"
- },
- "issue": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2"
- },
- "comments": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/2/comments"
- },
- "review_comments": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/comments"
- },
- "review_comment": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/comments{/number}"
- },
- "commits": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls/2/commits"
- },
- "statuses": {
- "href": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/14977a7b5485400124827221a04bfb474bcd72d1"
- }
- },
- "author_association": "OWNER"
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:37:10Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- push
-One or more commits are pushed to a repository branch or tag.
-- Note: You will not receive a webhook for this event - when you push more than three tags at once. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
contents
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
ref |
- string |
-
- The full
- git ref
- that was pushed. Example: refs/heads/main .
- |
-
before |
- string |
-
- The SHA of the most recent commit on ref before the
- push.
- |
-
after |
- string |
-
- The SHA of the most recent commit on ref after the
- push.
- |
-
commits |
- array |
- - An array of commit objects describing the pushed commits. (The array - includes a maximum of 20 commits. If necessary, you can use the - Commits API - to fetch additional commits. This limit is applied to timeline - events only and isn't applied to webhook deliveries.) - | -
commits[][id] |
- string |
- The SHA of the commit. | -
commits[][timestamp] |
- string |
- The ISO 8601 timestamp of the commit. | -
commits[][message] |
- string |
- The commit message. | -
commits[][author] |
- object |
- The git author of the commit. | -
commits[][author][name] |
- string |
- The git author's name. | -
commits[][author][email] |
- string |
- The git author's email address. | -
commits[][url] |
- url |
- URL that points to the commit API resource. | -
commits[][distinct] |
- boolean |
- - Whether this commit is distinct from any that have been pushed - before. - | -
commits[][added] |
- array |
- An array of files added in the commit. | -
commits[][modified] |
- array |
- An array of files modified by the commit. | -
commits[][removed] |
- array |
- An array of files removed in the commit. | -
pusher |
- object |
- The user who pushed the commits. | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "ref": "refs/tags/simple-tag",
- "before": "4544205a385319fd846d5df4ed2e3b8173529d78",
- "after": "0000000000000000000000000000000000000000",
- "created": false,
- "deleted": true,
- "forced": false,
- "base_ref": null,
- "compare": "https://octocoders.github.io/Codertocat/Hello-World/compare/4544205a3853...000000000000",
- "commits": [],
- "head_commit": null,
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "name": "Codertocat",
- "email": "Codertocat@Octocoders.io",
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": 1557949027,
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": 1557949103,
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master",
- "stargazers": 0,
- "master_branch": "master"
- },
- "pusher": {
- "name": "Codertocat",
- "email": "Codertocat@Octocoders.io"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- release
-
- Activity related to a release. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "releases" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
contents
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of:
-
|
-
changes[body][from] |
- string |
-
- The previous version of the body if the action was
- edited .
- |
-
changes[name][from] |
- string |
-
- The previous version of the name if the action was
- edited .
- |
-
release |
- object |
- - The - release - object. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "published",
- "release": {
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2",
- "assets_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases/2/assets",
- "upload_url": "https://octocoders.github.io/api/uploads/repos/Codertocat/Hello-World/releases/2/assets{?name,label}",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/releases/tag/0.0.1",
- "id": 2,
- "node_id": "MDc6UmVsZWFzZTI=",
- "tag_name": "0.0.1",
- "target_commitish": "master",
- "name": null,
- "draft": false,
- "author": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "prerelease": false,
- "created_at": "2019-05-15T19:37:08Z",
- "published_at": "2019-05-15T19:38:20Z",
- "assets": [],
- "tarball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tarball/0.0.1",
- "zipball_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/zipball/0.0.1",
- "body": null
- },
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:19Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- - repository_dispatch -
-
- This event occurs when a GitHub App sends a POST
request to
- the "Create a repository dispatch event" endpoint.
-
Availability
--
-
-
- GitHub Apps must have the
contents
permission to receive - this webhook. -
-
- Webhook payload example -
-{
- "action": "on-demand-test",
- "branch": "master",
- "client_payload": {
- "unit": false,
- "integration": true
- },
- "repository": {
- "id": 17273051,
- "node_id": "MDEwOlJlcG9zaXRvcnkxNzI3MzA1MQ==",
- "name": "octo-repo",
- "full_name": "octo-org/octo-repo",
- "private": true,
- "owner": {
- "login": "octo-org",
- "id": 6811672,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
- "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/octo-org",
- "html_url": "https://github.com/octo-org",
- "followers_url": "https://api.github.com/users/octo-org/followers",
- "following_url": "https://api.github.com/users/octo-org/following{/other_user}",
- "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
- "organizations_url": "https://api.github.com/users/octo-org/orgs",
- "repos_url": "https://api.github.com/users/octo-org/repos",
- "events_url": "https://api.github.com/users/octo-org/events{/privacy}",
- "received_events_url": "https://api.github.com/users/octo-org/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "html_url": "https://github.com/octo-org/octo-repo",
- "description": "My first repo on GitHub!",
- "fork": false,
- "url": "https://api.github.com/repos/octo-org/octo-repo",
- "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
- "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
- "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
- "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
- "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
- "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
- "events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
- "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
- "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
- "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
- "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
- "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
- "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
- "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
- "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
- "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
- "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
- "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
- "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
- "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
- "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
- "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
- "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
- "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
- "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
- "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
- "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
- "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
- "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
- "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
- "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
- "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
- "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
- "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
- "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
- "created_at": "2014-02-28T02:42:51Z",
- "updated_at": "2018-10-10T15:58:51Z",
- "pushed_at": "2018-10-10T15:58:47Z",
- "git_url": "git://github.com/octo-org/octo-repo.git",
- "ssh_url": "git@github.com:octo-org/octo-repo.git",
- "clone_url": "https://github.com/octo-org/octo-repo.git",
- "svn_url": "https://github.com/octo-org/octo-repo",
- "homepage": "",
- "size": 59,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "JavaScript",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": false,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "open_issues_count": 23,
- "license": null,
- "forks": 1,
- "open_issues": 23,
- "watchers": 0,
- "default_branch": "master"
- },
- "organization": {
- "login": "octo-org",
- "id": 6811672,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
- "url": "https://api.github.com/orgs/octo-org",
- "repos_url": "https://api.github.com/orgs/octo-org/repos",
- "events_url": "https://api.github.com/orgs/octo-org/events",
- "hooks_url": "https://api.github.com/orgs/octo-org/hooks",
- "issues_url": "https://api.github.com/orgs/octo-org/issues",
- "members_url": "https://api.github.com/orgs/octo-org/members{/member}",
- "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
- "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
- "description": "Working better together!"
- },
- "sender": {
- "login": "Codertocat",
- "id": 21031067,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 375706,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMzc1NzA2"
- }
-}
-
- repository
-
- Activity related to a repository. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "repositories" REST API.
-
Availability
--
-
-
- Repository webhooks receive all event types except
deleted
-
- - Organization webhooks -
-
- GitHub Apps with the
metadata
permission receive all event - types exceptdeleted
-
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. This can be one of:
-
|
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "publicized",
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:25Z",
- "pushed_at": "2019-05-15T19:38:23Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- - security_advisory -
-- Activity related to a security advisory. A security advisory provides - information about security-related vulnerabilities in software on GitHub. - The security advisory dataset also powers the GitHub security alerts, see - "About alerts for vulnerable dependencies." -
-Availability
--
-
- GitHub Apps with the
security_events
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. The action can be one of
- published , updated ,
- performed , or withdrawn for all new
- events.
- |
-
security_advisory |
- object |
- - The details of the security advisory, including summary, - description, and severity. - | -
- Webhook payload example -
-{
- "action": "published",
- "security_advisory": {
- "ghsa_id": "GHSA-rf4j-j272-fj86",
- "summary": "Moderate severity vulnerability that affects django",
- "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.",
- "severity": "moderate",
- "identifiers": [
- {
- "value": "GHSA-rf4j-j272-fj86",
- "type": "GHSA"
- },
- {
- "value": "CVE-2018-6188",
- "type": "CVE"
- }
- ],
- "references": [
- {
- "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188"
- }
- ],
- "published_at": "2018-10-03T21:13:54Z",
- "updated_at": "2018-10-03T21:13:54Z",
- "withdrawn_at": null,
- "vulnerabilities": [
- {
- "package": {
- "ecosystem": "pip",
- "name": "django"
- },
- "severity": "moderate",
- "vulnerable_version_range": ">= 2.0.0, < 2.0.2",
- "first_patched_version": {
- "identifier": "2.0.2"
- }
- },
- {
- "package": {
- "ecosystem": "pip",
- "name": "django"
- },
- "severity": "moderate",
- "vulnerable_version_range": ">= 1.11.8, < 1.11.10",
- "first_patched_version": {
- "identifier": "1.11.10"
- }
- }
- ]
- }
-}
-
- star
-
- Activity related to a repository being starred. The type of activity is
- specified in the action
property of the payload object. For
- more information, see the "starring" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action performed. Can be created or
- deleted .
- |
-
starred_at |
- string |
-
- The time the star was created. This is a timestamp in
- ISO 8601
- format: YYYY-MM-DDTHH:MM:SSZ . Will be
- null for the deleted action.
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "created",
- "starred_at": "2019-05-15T15:20:40Z",
- "repository": {
- "id": 186853002,
- "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 21031067,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://github.com/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://api.github.com/repos/Codertocat/Hello-World",
- "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T15:19:25Z",
- "updated_at": "2019-05-15T15:20:40Z",
- "pushed_at": "2019-05-15T15:20:33Z",
- "git_url": "git://github.com/Codertocat/Hello-World.git",
- "ssh_url": "git@github.com:Codertocat/Hello-World.git",
- "clone_url": "https://github.com/Codertocat/Hello-World.git",
- "svn_url": "https://github.com/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 1,
- "watchers_count": 1,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 1,
- "default_branch": "master"
- },
- "sender": {
- "login": "Codertocat",
- "id": 21031067,
- "node_id": "MDQ6VXNlcjIxMDMxMDY3",
- "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
- "gravatar_id": "",
- "url": "https://api.github.com/users/Codertocat",
- "html_url": "https://github.com/Codertocat",
- "followers_url": "https://api.github.com/users/Codertocat/followers",
- "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
- "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
- "organizations_url": "https://api.github.com/users/Codertocat/orgs",
- "repos_url": "https://api.github.com/users/Codertocat/repos",
- "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
- "received_events_url": "https://api.github.com/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- }
-}
-
- status
-
- When the status of a Git commit changes. The type of activity is specified
- in the action
property of the payload object. For more
- information, see the "statuses" REST API.
-
Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
statuses
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
id |
- integer |
- The unique identifier of the status. | -
sha |
- string |
- The Commit SHA. | -
state |
- string |
-
- The new state. Can be pending , success ,
- failure , or error .
- |
-
description |
- string |
- The optional human-readable description added to the status. | -
target_url |
- string |
- The optional link added to the status. | -
branches |
- array |
- - An array of branch objects containing the status' SHA. Each branch - contains the given SHA, but the SHA may or may not be the head of - the branch. The array includes a maximum of 10 branches. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "id": 2,
- "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
- "name": "Codertocat/Hello-World",
- "target_url": null,
- "context": "default",
- "description": null,
- "state": "success",
- "commit": {
- "sha": "4544205a385319fd846d5df4ed2e3b8173529d78",
- "node_id": "MDY6Q29tbWl0MTE4OjQ1NDQyMDVhMzg1MzE5ZmQ4NDZkNWRmNGVkMmUzYjgxNzM1MjlkNzg=",
- "commit": {
- "author": {
- "name": "Codertocat",
- "email": "Codertocat@Octocoders.io",
- "date": "2019-05-15T19:37:08Z"
- },
- "committer": {
- "name": "GitHub Enterprise",
- "email": "noreply@octocoders.github.io",
- "date": "2019-05-15T19:37:08Z"
- },
- "message": "Initial commit",
- "tree": {
- "sha": "1b13fc88733f95cc8cb16170f6990ef30d78acf4",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees/1b13fc88733f95cc8cb16170f6990ef30d78acf4"
- },
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
- "comment_count": 1,
- "verification": {
- "verified": false,
- "reason": "unsigned",
- "signature": null,
- "payload": null
- }
- },
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78",
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World/commit/4544205a385319fd846d5df4ed2e3b8173529d78",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/4544205a385319fd846d5df4ed2e3b8173529d78/comments",
- "author": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "committer": null,
- "parents": []
- },
- "branches": [
- {
- "name": "master",
- "commit": {
- "sha": "78a96099c3f442d7f6e8d1a7d07090091993e65a",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/78a96099c3f442d7f6e8d1a7d07090091993e65a"
- },
- "protected": false
- },
- {
- "name": "changes",
- "commit": {
- "sha": "14977a7b5485400124827221a04bfb474bcd72d1",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/14977a7b5485400124827221a04bfb474bcd72d1"
- },
- "protected": false
- },
- {
- "name": "gh-pages",
- "commit": {
- "sha": "3648135c2986115284ae152d90459473b15fd19c",
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits/3648135c2986115284ae152d90459473b15fd19c"
- },
- "protected": false
- }
- ],
- "created_at": "2019-05-15T19:38:21+00:00",
- "updated_at": "2019-05-15T19:38:21+00:00",
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:15Z",
- "pushed_at": "2019-05-15T19:38:19Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 1,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 1,
- "open_issues": 2,
- "watchers": 0,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
- team
-
- Activity related to an organization's team. The type of activity is
- specified in the action
property of the payload object. For
- more information, see the "teams" REST API.
-
Availability
--
-
- Organization webhooks -
- GitHub Apps with the
members
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Can be one of created ,
- deleted , edited ,
- added_to_repository , or
- removed_from_repository .
- |
-
team |
- object |
- The team itself. | -
changes |
- object |
-
- The changes to the team if the action was edited .
- |
-
changes[description][from] |
- string |
-
- The previous version of the description if the action was
- edited .
- |
-
changes[name][from] |
- string |
-
- The previous version of the name if the action was
- edited .
- |
-
changes[privacy][from] |
- string |
-
- The previous version of the team's privacy if the action was
- edited .
- |
-
changes[repository][permissions][from][admin] |
- boolean |
-
- The previous version of the team member's
- admin permission on a repository, if the action was
- edited .
- |
-
changes[repository][permissions][from][pull] |
- boolean |
-
- The previous version of the team member's
- pull permission on a repository, if the action was
- edited .
- |
-
changes[repository][permissions][from][push] |
- boolean |
-
- The previous version of the team member's
- push permission on a repository, if the action was
- edited .
- |
-
repository |
- object |
-
- The repository that was added or removed from to the team's purview
- if the action was added_to_repository ,
- removed_from_repository , or edited . For
- edited actions, repository also contains
- the team's new permission levels for the repository.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-team_add
-- When a - repository is added to a team. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
members
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
team |
- object |
- - The - team - that was modified. Note: Older events may not - include this in the payload. - | -
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "team": {
- "name": "github",
- "id": 3,
- "node_id": "MDQ6VGVhbTM=",
- "slug": "github",
- "description": "Open-source team",
- "privacy": "secret",
- "url": "https://octocoders.github.io/api/v3/teams/3",
- "html_url": "https://octocoders.github.io/orgs/Octocoders/teams/github",
- "members_url": "https://octocoders.github.io/api/v3/teams/3/members{/member}",
- "repositories_url": "https://octocoders.github.io/api/v3/teams/3/repos",
- "permission": "pull"
- },
- "repository": {
- "id": 120,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMjA=",
- "name": "Hello-World",
- "full_name": "Octocoders/Hello-World",
- "private": false,
- "owner": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Octocoders/Hello-World",
- "description": null,
- "fork": true,
- "url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Octocoders/Hello-World/deployments",
- "created_at": "2019-05-15T19:38:10Z",
- "updated_at": "2019-05-15T19:38:14Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Octocoders/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Octocoders/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Octocoders/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Octocoders/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 0,
- "watchers_count": 0,
- "language": "Ruby",
- "has_issues": false,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": false,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 0,
- "license": null,
- "forks": 0,
- "open_issues": 0,
- "watchers": 0,
- "default_branch": "master"
- },
- "organization": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "url": "https://octocoders.github.io/api/v3/orgs/Octocoders",
- "repos_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/events",
- "hooks_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/hooks",
- "issues_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/issues",
- "members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/members{/member}",
- "public_members_url": "https://octocoders.github.io/api/v3/orgs/Octocoders/public_members{/member}",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "description": ""
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Octocoders",
- "id": 6,
- "node_id": "MDEyOk9yZ2FuaXphdGlvbjY=",
- "avatar_url": "https://octocoders.github.io/avatars/u/6?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Octocoders",
- "html_url": "https://octocoders.github.io/Octocoders",
- "followers_url": "https://octocoders.github.io/api/v3/users/Octocoders/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Octocoders/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Octocoders/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Octocoders/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Octocoders/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Octocoders/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Octocoders/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Octocoders/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Octocoders/received_events",
- "type": "Organization",
- "site_admin": false
- }
-}
-
- user
-When a user is created
or deleted
.
Availability
--
-
- - GitHub Enterprise webhooks. For more information, "Global webhooks." - -
- Webhook payload example -
-watch
-
- When someone stars a repository. The type of activity is specified in the
- action
property of the payload object. For more information,
- see the "starring" REST API.
-
- The event’s actor is the - user who - starred a repository, and the event’s repository is the - repository - that was starred. -
-Availability
--
-
- Repository webhooks -
- Organization webhooks -
- GitHub Apps with the
metadata
permission
-
- Webhook payload object -
- -Key | -Type | -Description | -
---|---|---|
action |
- string |
-
- The action that was performed. Currently, can only be
- started .
- |
-
repository |
- object |
-
- The
- repository
- where the event occurred.
- |
-
organization |
- object |
-
- Webhook payloads contain the
- organization
- object when the webhook is configured for an organization or the
- event occurs from activity in a repository owned by an organization.
- |
-
installation |
- object |
-
- The GitHub App installation. Webhook payloads contain the
- installation property when the event is configured for
- and sent to a GitHub App.
- |
-
sender |
- object |
- The user that triggered the event. | -
- Webhook payload example -
-{
- "action": "started",
- "repository": {
- "id": 118,
- "node_id": "MDEwOlJlcG9zaXRvcnkxMTg=",
- "name": "Hello-World",
- "full_name": "Codertocat/Hello-World",
- "private": false,
- "owner": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "html_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "description": null,
- "fork": false,
- "url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World",
- "forks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/forks",
- "keys_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/keys{/key_id}",
- "collaborators_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/collaborators{/collaborator}",
- "teams_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/teams",
- "hooks_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/hooks",
- "issue_events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/events{/number}",
- "events_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/events",
- "assignees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/assignees{/user}",
- "branches_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/branches{/branch}",
- "tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/tags",
- "blobs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/blobs{/sha}",
- "git_tags_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/tags{/sha}",
- "git_refs_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/refs{/sha}",
- "trees_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/trees{/sha}",
- "statuses_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/statuses/{sha}",
- "languages_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/languages",
- "stargazers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/stargazers",
- "contributors_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contributors",
- "subscribers_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscribers",
- "subscription_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/subscription",
- "commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/commits{/sha}",
- "git_commits_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/git/commits{/sha}",
- "comments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/comments{/number}",
- "issue_comment_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues/comments{/number}",
- "contents_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/contents/{+path}",
- "compare_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/compare/{base}...{head}",
- "merges_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/merges",
- "archive_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/{archive_format}{/ref}",
- "downloads_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/downloads",
- "issues_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/issues{/number}",
- "pulls_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/pulls{/number}",
- "milestones_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/milestones{/number}",
- "notifications_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
- "labels_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/labels{/name}",
- "releases_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/releases{/id}",
- "deployments_url": "https://octocoders.github.io/api/v3/repos/Codertocat/Hello-World/deployments",
- "created_at": "2019-05-15T19:37:07Z",
- "updated_at": "2019-05-15T19:38:09Z",
- "pushed_at": "2019-05-15T19:38:03Z",
- "git_url": "git://octocoders.github.io/Codertocat/Hello-World.git",
- "ssh_url": "git@octocoders.github.io:Codertocat/Hello-World.git",
- "clone_url": "https://octocoders.github.io/Codertocat/Hello-World.git",
- "svn_url": "https://octocoders.github.io/Codertocat/Hello-World",
- "homepage": null,
- "size": 0,
- "stargazers_count": 1,
- "watchers_count": 1,
- "language": null,
- "has_issues": true,
- "has_projects": true,
- "has_downloads": true,
- "has_wiki": true,
- "has_pages": true,
- "forks_count": 0,
- "mirror_url": null,
- "archived": false,
- "disabled": false,
- "open_issues_count": 2,
- "license": null,
- "forks": 0,
- "open_issues": 2,
- "watchers": 1,
- "default_branch": "master"
- },
- "enterprise": {
- "id": 1,
- "slug": "github",
- "name": "GitHub",
- "node_id": "MDg6QnVzaW5lc3Mx",
- "avatar_url": "https://octocoders.github.io/avatars/b/1?",
- "description": null,
- "website_url": null,
- "html_url": "https://octocoders.github.io/businesses/github",
- "created_at": "2019-05-14T19:31:12Z",
- "updated_at": "2019-05-14T19:31:12Z"
- },
- "sender": {
- "login": "Codertocat",
- "id": 4,
- "node_id": "MDQ6VXNlcjQ=",
- "avatar_url": "https://octocoders.github.io/avatars/u/4?",
- "gravatar_id": "",
- "url": "https://octocoders.github.io/api/v3/users/Codertocat",
- "html_url": "https://octocoders.github.io/Codertocat",
- "followers_url": "https://octocoders.github.io/api/v3/users/Codertocat/followers",
- "following_url": "https://octocoders.github.io/api/v3/users/Codertocat/following{/other_user}",
- "gists_url": "https://octocoders.github.io/api/v3/users/Codertocat/gists{/gist_id}",
- "starred_url": "https://octocoders.github.io/api/v3/users/Codertocat/starred{/owner}{/repo}",
- "subscriptions_url": "https://octocoders.github.io/api/v3/users/Codertocat/subscriptions",
- "organizations_url": "https://octocoders.github.io/api/v3/users/Codertocat/orgs",
- "repos_url": "https://octocoders.github.io/api/v3/users/Codertocat/repos",
- "events_url": "https://octocoders.github.io/api/v3/users/Codertocat/events{/privacy}",
- "received_events_url": "https://octocoders.github.io/api/v3/users/Codertocat/received_events",
- "type": "User",
- "site_admin": false
- },
- "installation": {
- "id": 5,
- "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uNQ=="
- }
-}
-
-