GitHub v3 REST API

Timeline Comment Event

object

Timeline Comment Event

eventstringrequired
actorobjectrequired

Simple User

Show Child Parameters
idintegerrequired

Unique identifier of the issue comment

Example:42

node_idstringrequired
urlstring(uri)required

URL for the issue comment

Example:https://api.github.com/repositories/42/issues/comments/1

bodystring

Contents of the issue comment

Example:What version of Safari were you using when you observed this bug?

body_textstring
body_htmlstring
html_urlstring(uri)required
userobjectrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-14T16:00:49Z

updated_atstring(date-time)required

Example:2011-04-14T16:00:49Z

issue_urlstring(uri)required
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

performed_via_github_appobject

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Show Child Parameters
reactionsobject
Show Child Parameters
Example

Timeline Cross Referenced Event

object

Timeline Cross Referenced Event

eventstringrequired
actorobject

Simple User

Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
sourceobjectrequired
Show Child Parameters
Example

Timeline Committed Event

object

Timeline Committed Event

eventstring
shastringrequired

SHA for the commit

Example:7638417db6d59f3c431d3e1f261cc637155684cd

node_idstringrequired
urlstring(uri)required
authorobjectrequired

Identifying information for the git-user

Show Child Parameters
committerobjectrequired

Identifying information for the git-user

Show Child Parameters
messagestringrequired

Message describing the purpose of the commit

Example:Fix #42

treeobjectrequired
Show Child Parameters
parentsarray[object]required
Show Child Parameters
verificationobjectrequired
Show Child Parameters
html_urlstring(uri)required
Example

Timeline Reviewed Event

object

Timeline Reviewed Event

eventstringrequired
idintegerrequired

Unique identifier of the review

Example:42

node_idstringrequired

Example:MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=

userobjectrequired

Simple User

Show Child Parameters
bodystringrequired

The text of the review.

Example:This looks great.

statestringrequired

Example:CHANGES_REQUESTED

html_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80

pull_request_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/12

_linksobjectrequired
Show Child Parameters
submitted_atstring(date-time)
commit_idstringrequired

A commit SHA for the review.

Example:54bb654c9e6025347f57900a4a5c2313a96b8035

body_htmlstring
body_textstring
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

Example

Pull Request Review Comment

object

Pull Request Review Comments are comments on a portion of the Pull Request’s diff.

urlstringrequired

URL for the pull request review comment

Example:https://api.github.com/repos/octocat/Hello-World/pulls/comments/1

pull_request_review_idintegerrequired

The ID of the pull request review to which the comment belongs.

Example:42

idintegerrequired

The ID of the pull request review comment.

Example:1

node_idstringrequired

The node ID of the pull request review comment.

Example:MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw

diff_hunkstringrequired

The diff of the line that the comment refers to.

Example:@@ -16,33 +16,40 @@ public class Connection : IConnection...

pathstringrequired

The relative path of the file to which the comment applies.

Example:config/database.yaml

positionintegerrequired

The line index in the diff to which the comment applies.

Example:1

original_positionintegerrequired

The index of the original line in the diff to which the comment applies.

Example:4

commit_idstringrequired

The SHA of the commit to which the comment applies.

Example:6dcb09b5b57875f334f61aebed695e2e4193db5e

original_commit_idstringrequired

The SHA of the original commit to which the comment applies.

Example:9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840

in_reply_to_idinteger

The comment ID to reply to.

Example:8

userobjectrequired

Simple User

Show Child Parameters
bodystringrequired

The text of the comment.

Example:We should probably include a check for null values here.

created_atstring(date-time)required

Example:2011-04-14T16:00:49Z

updated_atstring(date-time)required

Example:2011-04-14T16:00:49Z

html_urlstring(uri)required

HTML URL for the pull request review comment.

Example:https://github.com/octocat/Hello-World/pull/1#discussion-diff-1

pull_request_urlstring(uri)required

URL for the pull request that the review comment belongs to.

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1

author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

_linksobjectrequired
Show Child Parameters
start_lineinteger

The first line of the range for a multi-line comment.

Example:2

original_start_lineinteger

The first line of the range for a multi-line comment.

Example:2

start_sidestring

The side of the first line of the range for a multi-line comment.

Allowed values:LEFTRIGHT

Default:RIGHT

lineinteger

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example:2

original_lineinteger

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example:2

sidestring

The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment

Allowed values:LEFTRIGHT

Default:RIGHT

reactionsobject
Show Child Parameters
body_htmlstring

Example:"<p>comment body</p>"

body_textstring

Example:"comment body"

Example