Skip to content

Commit c74f178

Browse files
committed
Merge pull request github#1033 from julianlam/master
Updated "push" event payload to match reality
2 parents 774c1a0 + c3a64dd commit c74f178

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

content/v3/activity/events/types.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -416,13 +416,21 @@ Key | Type | Description
416416
`size`|`integer` | The number of commits in the push.
417417
`distinct_size`|`integer` | The number of distinct commits in the push.
418418
`commits`|`array` | An array of commit objects describing the pushed commits. (The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](/v3/repos/commits/) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.)
419-
`commits[][sha]`|`string` | The SHA of the commit.
419+
`commits[][id]`|`string` | The SHA of the commit.
420+
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
420421
`commits[][message]`|`string` | The commit message.
422+
`commits[][timestamp]`|`string` | The date and time of the commit, in ISO8601 format with time zone offset (e.g. `2007-04-05T12:30-02:00`)
423+
`commits[][url]`|`url` | Points to the commit API resource.
421424
`commits[][author]`|`object` | The git author of the commit.
422425
`commits[][author][name]`|`string` | The git author's name.
423426
`commits[][author][email]`|`string` | The git author's email address.
424-
`commits[][url]`|`url` | Points to the commit API resource.
425-
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
427+
`commits[][author][username]`|`string` | The git author's GitHub username.
428+
`commits[][committer][name]`|`string` | The git committer's name.
429+
`commits[][committer][email]`|`string` | The git committer's email address.
430+
`commits[][committer][username]`|`string` | The git committer's GitHub username.
431+
`commits[][added]`|`array` | A list of files added by this commit
432+
`commits[][removed]`|`array` | A list of files removed by this commit
433+
`commits[][modified]`|`array` | A list of files modified by this commit
426434

427435
### Webhook event name
428436

0 commit comments

Comments
 (0)