GitHub v3 REST API

Removed from Project Issue Event

object

Removed from Project Issue Event

idintegerrequired
node_idstringrequired
urlstringrequired
actorobjectrequired

Simple User

Show Child Parameters
eventstringrequired
commit_idstringrequired
commit_urlstringrequired
created_atstringrequired
performed_via_github_appobjectrequired

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
project_cardobject
Show Child Parameters
Example

Converted Note to Issue Issue Event

object

Converted Note to Issue Issue Event

idintegerrequired
node_idstringrequired
urlstringrequired
actorobjectrequired

Simple User

Show Child Parameters
eventstringrequired
commit_idstringrequired
commit_urlstringrequired
created_atstringrequired
performed_via_github_appobjectrequired

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
project_cardobject
Show Child Parameters
Example

Issue Event for Issue

Issue Event for Issue

Any Of
idintegerrequired
node_idstringrequired
urlstringrequired
actorobjectrequired

Simple User

Show Child Parameters
eventstringrequired
commit_idstringrequired
commit_urlstringrequired
created_atstringrequired
performed_via_github_appobjectrequired

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
labelobjectrequired
Show Child Parameters
Example

Label

object

Color-coded labels help you categorize and filter your issues (just like labels in Gmail).

idinteger(int64)required

Example:208045946

node_idstringrequired

Example:MDU6TGFiZWwyMDgwNDU5NDY=

urlstring(uri)required

URL for the label

Example:https://api.github.com/repositories/42/labels/bug

namestringrequired

The name of the label.

Example:bug

descriptionstringrequired

Example:Something isn't working

colorstringrequired

6-character hex code, without the leading #, identifying the color

Example:FFFFFF

defaultbooleanrequired

Example:true

Example

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