-
Notifications
You must be signed in to change notification settings - Fork 68.3k
Expand file tree
/
Copy pathcommit_comment.json
More file actions
64 lines (64 loc) · 3.77 KB
/
Copy pathcommit_comment.json
File metadata and controls
64 lines (64 loc) · 3.77 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
"created": {
"descriptionHtml": "<p>Someone commented on a commit.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"<a href=\"https://docs.github.com/enterprise-server@3.17/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request\">Commenting on a pull request</a>.\" For information about the APIs to manage commit comments, see <a href=\"https://docs.github.com/enterprise-server@3.17/graphql/reference/objects#commitcomment\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.17/rest/commits/comments\">Commit comments</a>\" in the REST API documentation.</p>\n<p>For activity relating to comments on pull request reviews, use the <code>pull_request_review_comment</code> event. For activity relating to issue comments, use the <code>issue_comment</code> event. For activity relating to discussion comments, use the <code>discussion_comment</code> event.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"description": "<p>The action performed. Can be <code>created</code>.</p>",
"isRequired": true,
"enum": [
"created"
],
"childParamsGroups": []
},
{
"type": "object",
"name": "comment",
"description": "<p>The <a href=\"$%7BexternalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl%7D/rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.17/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "installation",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.17/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
"description": "<p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"description": "<p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property\nwhen the event occurs from activity in a repository.</p>",
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"description": "<p>A GitHub user.</p>",
"isRequired": true,
"childParamsGroups": []
}
],
"availability": [
"repository",
"organization",
"app"
],
"action": "created",
"category": "commit_comment"
}
}