Properties
| Name | Type | Description |
|---|---|---|
| action | string | |
| comment | object | The [comment](https://docs.github.com/[email protected]/rest/issues/comments#get-an-issue-comment) itself. |
| enterprise | object | |
| installation | object | |
| issue | object | The [issue](https://docs.github.com/[email protected]/rest/issues/issues#get-an-issue) the comment belongs to. |
| organization | object | |
| repository | object | |
| sender | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhook-issue-comment-created",
"title": "issue_comment created event",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"created"
]
},
"comment": {
"title": "issue comment",
"description": "The [comment](https://docs.github.com/[email protected]/rest/issues/comments#get-an-issue-comment) itself.",
"type": "object",
"properties": {
"author_association": {
"title": "AuthorAssociation",
"description": "How the author is associated with the repository.",
"type": "string",
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
"body": {
"description": "Contents of the issue comment",
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"description": "Unique identifier of the issue comment",
"type": "integer",
"format": "int64"
},
"issue_url": {
"type": "string",
"format": "uri"
},
"node_id": {
"type": "string"
},
"performed_via_github_app": {
"$ref": "#/components/schemas/nullable-integration"
},
"reactions": {
"title": "Reactions",
"type": "object",
"properties": {
"+1": {
"type": "integer"
},
"-1": {
"type": "integer"
},
"confused": {
"type": "integer"
},
"eyes": {
"type": "integer"
},
"heart": {
"type": "integer"
},
"hooray": {
"type": "integer"
},
"laugh": {
"type": "integer"
},
"rocket": {
"type": "integer"
},
"total_count": {
"type": "integer"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"total_count",
"+1",
"-1",
"laugh",
"confused",
"heart",
"hooray",
"eyes",
"rocket"
]
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"description": "URL for the issue comment",
"type": "string",
"format": "uri"
},
"user": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer",
"format": "int64"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
}
},
"required": [
"url",
"html_url",
"issue_url",
"id",
"node_id",
"user",
"created_at",
"updated_at",
"author_association",
"performed_via_github_app",
"body",
"reactions"
]
},
"enterprise": {
"$ref": "#/components/schemas/enterprise-webhooks"
},
"installation": {
"$ref": "#/components/schemas/simple-installation"
},
"issue": {
"description": "The [issue](https://docs.github.com/[email protected]/rest/issues/issues#get-an-issue) the comment belongs to.",
"allOf": [
{
"title": "Issue",
"description": "The [issue](https://docs.github.com/[email protected]/rest/issues/issues#get-an-issue) itself.",
"type": "object",
"properties": {
"active_lock_reason": {
"type": "string",
"nullable": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
"assignee": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"assignees": {
"type": "array",
"items": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
}
},
"author_association": {
"title": "AuthorAssociation",
"description": "How the author is associated with the repository.",
"type": "string",
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
"body": {
"description": "Contents of the issue",
"type": "string",
"nullable": true
},
"closed_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"comments": {
"type": "integer"
},
"comments_url": {
"type": "string",
"format": "uri"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"draft": {
"type": "boolean"
},
"events_url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer",
"format": "int64"
},
"labels": {
"type": "array",
"items": {
"title": "Label",
"type": "object",
"properties": {
"color": {
"description": "6-character hex code, without the leading #, identifying the color",
"type": "string"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer"
},
"name": {
"description": "The name of the label.",
"type": "string"
},
"node_id": {
"type": "string"
},
"url": {
"description": "URL for the label",
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"node_id",
"url",
"name",
"color",
"default",
"description"
]
}
},
"labels_url": {
"type": "string",
"format": "uri-template"
},
"locked": {
"type": "boolean"
},
"milestone": {
"title": "Milestone",
"description": "A collection of related issues and pull requests.",
"type": "object",
"nullable": true,
"properties": {
"closed_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"closed_issues": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"creator": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"description": {
"type": "string",
"nullable": true
},
"due_on": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"labels_url": {
"type": "string",
"format": "uri"
},
"node_id": {
"type": "string"
},
"number": {
"description": "The number of the milestone.",
"type": "integer"
},
"open_issues": {
"type": "integer"
},
"state": {
"description": "The state of the milestone.",
"type": "string",
"enum": [
"open",
"closed"
]
},
"title": {
"description": "The title of the milestone.",
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"html_url",
"labels_url",
"id",
"node_id",
"number",
"title",
"description",
"creator",
"open_issues",
"closed_issues",
"state",
"created_at",
"updated_at",
"due_on",
"closed_at"
]
},
"node_id": {
"type": "string"
},
"number": {
"type": "integer"
},
"performed_via_github_app": {
"title": "App",
"description": "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.",
"type": "object",
"nullable": true,
"properties": {
"created_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"events": {
"description": "The list of events for the GitHub app",
"type": "array",
"items": {
"type": "string",
"enum": [
"branch_protection_rule",
"check_run",
"check_suite",
"code_scanning_alert",
"commit_comment",
"content_reference",
"create",
"delete",
"deployment",
"deployment_review",
"deployment_status",
"deploy_key",
"discussion",
"discussion_comment",
"fork",
"gollum",
"issues",
"issue_comment",
"label",
"member",
"membership",
"milestone",
"organization",
"org_block",
"page_build",
"project",
"project_card",
"project_column",
"public",
"pull_request",
"pull_request_review",
"pull_request_review_comment",
"push",
"registry_package",
"release",
"repository",
"repository_dispatch",
"secret_scanning_alert",
"star",
"status",
"team",
"team_add",
"watch",
"workflow_dispatch",
"workflow_run",
"reminder",
"pull_request_review_thread"
]
}
},
"external_url": {
"type": "string",
"nullable": true,
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"description": "Unique identifier of the GitHub app",
"type": "integer",
"nullable": true
},
"name": {
"description": "The name of the GitHub app",
"type": "string"
},
"node_id": {
"type": "string"
},
"owner": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"login",
"id"
]
},
"permissions": {
"description": "The set of permissions for the GitHub app",
"type": "object",
"properties": {
"actions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"administration": {
"type": "string",
"enum": [
"read",
"write"
]
},
"checks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"content_references": {
"type": "string",
"enum": [
"read",
"write"
]
},
"contents": {
"type": "string",
"enum": [
"read",
"write"
]
},
"deployments": {
"type": "string",
"enum": [
"read",
"write"
]
},
"discussions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"emails": {
"type": "string",
"enum": [
"read",
"write"
]
},
"environments": {
"type": "string",
"enum": [
"read",
"write"
]
},
"issues": {
"type": "string",
"enum": [
"read",
"write"
]
},
"keys": {
"type": "string",
"enum": [
"read",
"write"
]
},
"members": {
"type": "string",
"enum": [
"read",
"write"
]
},
"metadata": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_packages": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_projects": {
"type": "string",
"enum": [
"read",
"write",
"admin"
]
},
"organization_secrets": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"type": "string",
"enum": [
"read",
"write"
]
},
"packages": {
"type": "string",
"enum": [
"read",
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/json-schema/apis-io-engineering-platform-webhook-issue-comment-created-schema.json