Skip to content

Commit 18c08d4

Browse files
gjtorikiangjtorikian
committed
Call out hook names as a separate header
1 parent 6244d62 commit 18c08d4

File tree

1 file changed

+101
-23
lines changed

1 file changed

+101
-23
lines changed

‎content/v3/activity/events/types.md‎

Lines changed: 101 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@ They're only created for various internal and repository hooks.
2121

2222
Triggered when a [commit comment](/v3/repos/comments/#list-commit-comments-for-a-repository) is created.
2323

24-
Hook name: `commit_comment`
24+
### Hook name
25+
26+
`commit_comment`
27+
28+
### Payload
2529

2630
Key | Type | Description
2731
----|------|-------------
@@ -32,7 +36,11 @@ Key | Type | Description
3236

3337
Represents a created repository, branch, or tag.
3438

35-
Hook name: `create`
39+
### Hook name
40+
41+
`create`
42+
43+
### Payload
3644

3745
Key | Type | Description
3846
----|------|-------------
@@ -46,7 +54,11 @@ Key | Type | Description
4654

4755
Represents a [deleted branch or tag](/v3/git/refs/#delete-a-reference).
4856

49-
Hook name: `delete`
57+
### Hook name
58+
59+
`delete`
60+
61+
### Payload
5062

5163
Key | Type | Description
5264
----|------|-------------
@@ -58,7 +70,11 @@ Key | Type | Description
5870

5971
Triggered when a new [download](/v3/repos/downloads/) is created.
6072

61-
Hook name: `download`
73+
### Hook name
74+
75+
`download`
76+
77+
### Payload
6278

6379
Events of this type are **no longer created**, but it's possible that they exist in timelines of some users.
6480

@@ -71,7 +87,11 @@ Key | Type | Description
7187

7288
Triggered when a user [follows another user](/v3/users/followers/#follow-a-user).
7389

74-
Hook name: `follow`
90+
### Hook name
91+
92+
`follow`
93+
94+
### Payload
7595

7696
Key | Type | Description
7797
----|------|-------------
@@ -82,7 +102,11 @@ Key | Type | Description
82102

83103
Triggered when a user [forks a repository](/v3/repos/forks/#create-a-fork).
84104

85-
Hook name: `fork`
105+
### Hook name
106+
107+
`fork`
108+
109+
### Payload
86110

87111
Key | Type | Description
88112
----|------|-------------
@@ -95,7 +119,11 @@ Triggered when a patch is applied in the Fork Queue.
95119

96120
Events of this type are **no longer created**, but it's possible that they exist in timelines of some users.
97121

98-
Hook name: `fork_apply`
122+
### Hook name
123+
124+
`fork_apply`
125+
126+
### Payload
99127

100128
Key | Type | Description
101129
----|------|-------------
@@ -108,7 +136,11 @@ Key | Type | Description
108136

109137
Triggered when a [Gist](/v3/gists/) is created or updated.
110138

111-
Hook name: `gist`
139+
### Hook name
140+
141+
`gist`
142+
143+
### Payload
112144

113145
Events of this type are **no longer created**, but it's possible that they exist in timelines of some users.
114146

@@ -122,7 +154,11 @@ Key | Type | Description
122154

123155
Triggered when a Wiki page is created or updated.
124156

125-
Hook name: `gollum`
157+
### Hook name
158+
159+
`gollum`
160+
161+
### Payload
126162

127163
Key | Type | Description
128164
----|------|-------------
@@ -138,7 +174,11 @@ Key | Type | Description
138174

139175
Triggered when an [issue comment](/v3/issues/comments/) is created.
140176

141-
Hook name: `issue_comment`
177+
### Hook name
178+
179+
`issue_comment`
180+
181+
### Payload
142182

143183
Key | Type | Description
144184
----|------|-------------
@@ -151,7 +191,11 @@ Key | Type | Description
151191

152192
Triggered when an [issue](/v3/issues) is created, closed or reopened.
153193

154-
Hook name: `issues`
194+
### Hook name
195+
196+
`issues`
197+
198+
### Payload
155199

156200
Key | Type | Description
157201
----|------|-------------
@@ -163,7 +207,11 @@ Key | Type | Description
163207

164208
Triggered when a user is [added as a collaborator](/v3/repos/collaborators/#add-collaborator) to a repository.
165209

166-
Hook name: `member`
210+
### Hook name
211+
212+
`member`
213+
214+
### Payload
167215

168216
Key | Type | Description
169217
----|------|-------------
@@ -175,15 +223,23 @@ Key | Type | Description
175223

176224
Triggered when a private repository is [open sourced](/v3/repos/#edit). Without a doubt: the best GitHub event.
177225

178-
Hook name: `public`
226+
### Hook name
227+
228+
`public`
229+
230+
### Payload
179231

180232
(empty payload)
181233

182234
## PullRequestEvent
183235

184236
Triggered when a [pull request](/v3/pulls) is created, closed, reopened or synchronized.
185237

186-
Hook name: `pull_request`
238+
### Hook name
239+
240+
`pull_request`
241+
242+
### Payload
187243

188244
Key | Type | Description
189245
----|------|-------------
@@ -196,7 +252,11 @@ Key | Type | Description
196252

197253
Triggered when a [comment is created on a portion of the unified diff](/v3/pulls/comments) of a pull request.
198254

199-
Hook name: `pull_request_review_comment`
255+
### Hook name
256+
257+
`pull_request_review_comment`
258+
259+
### Payload
200260

201261
Key | Type | Description
202262
----|------|-------------
@@ -207,7 +267,11 @@ Key | Type | Description
207267

208268
Triggered when a repository branch is pushed to.
209269

210-
Hook name: `push`
270+
### Hook name
271+
272+
`push`
273+
274+
### Payload
211275

212276
Key | Type | Description
213277
----|------|-------------
@@ -228,7 +292,11 @@ Key | Type | Description
228292

229293
Triggered when a [release](/v3/repos/releases/#get-a-single-release) is published.
230294

231-
Hook name: `release`
295+
### Hook name
296+
297+
`release`
298+
299+
### Payload
232300

233301
Key | Type | Description
234302
----|------|-------------
@@ -240,7 +308,11 @@ Key | Type | Description
240308

241309
Triggered when the status of a Git commit changes.
242310

243-
Hook name: `status`
311+
### Hook name
312+
313+
`status`
314+
315+
### Payload
244316

245317
Key | Type | Description
246318
----|------|-------------
@@ -257,7 +329,11 @@ Triggered when a [user is added to a team](/v3/orgs/teams/#add-team-member) or w
257329

258330
Note: this event is created in [users' organization timelines](/v3/activity/events/#list-events-for-an-organization).
259331

260-
Hook name: `team_add`
332+
### Hook name
333+
334+
`team_add`
335+
336+
### Payload
261337

262338
Key | Type | Description
263339
----|------|-------------
@@ -274,10 +350,12 @@ See [this API blog post](/changes/2012-9-5-watcher-api/) for an explanation.
274350
The event’s actor is the [user](/v3/users/) who starred a repository, and the
275351
event’s repo is the [repository](/v3/repos/) that was starred.
276352

277-
Hook name: `watch`
353+
### Hook name
278354

279-
Key | Type | Description
280-
----|------|-------------
281-
`action`|`string` | The action that was performed. Currently, can only be "started".
355+
`watch`
282356

357+
### Payload
283358

359+
Key | Type | Description
360+
----|------|-------------
361+
`action`|`string` | The action that was performed. Currently, can only be `started`.

0 commit comments

Comments
 (0)