Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix and extend push webhook documentation. #499

Merged
merged 3 commits into from
Oct 20, 2020
Merged

Fix and extend push webhook documentation. #499

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
211edbf
Correct the commits SHA key name.
coling Oct 13, 2020
05e4d63
Describe some more elements of the commit object
coling Oct 13, 2020
0b2591a
Merge branch 'main' into patch-1
lucascosti Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/developers/webhooks-and-events/webhook-events-and-payloads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -971,13 +971,17 @@ Key | Type | Description
`before`|`string` | The SHA of the most recent commit on `ref` before the push.
`after`|`string` | The SHA of the most recent commit on `ref` after the push.
`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.)
`commits[][sha]`|`string` | The SHA of the commit.
`commits[][id]`|`string` | The SHA of the commit.
`commits[][timestamp]`|`string` | The ISO 8601 timestamp of the commit.
`commits[][message]`|`string` | The commit message.
`commits[][author]`|`object` | The git author of the commit.
`commits[][author][name]`|`string` | The git author's name.
`commits[][author][email]`|`string` | The git author's email address.
`commits[][url]`|`url` | URL that points to the commit API resource.
`commits[][distinct]`|`boolean` | Whether this commit is distinct from any that have been pushed before.
`commits[][added]`|`array` | An array of files added in the commit.
`commits[][modified]`|`array` | An array of files modified by the commit.
`commits[][removed]`|`array` | An array of files removed in the commit.
`pusher` | `object` | The user who pushed the commits.
{% data reusables.webhooks.repo_desc %}
{% data reusables.webhooks.org_desc %}
Expand Down