github.pushpayload
Home > @runlightyear/github > PushPayload
PushPayload interface
Documentation: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads\#push
Signature:interface PushPayload extends CommonPayload
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| after | string | The SHA of the most recent commit on ref after the push. | |
| before | string | The SHA of the most recent commit on ref before the push. | |
| commits | Array<PushCommit> | An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) | |
| compare | string | URL that shows the changes in this ref update, from the before commit to the after commit. For a newly created ref that is directly based on the default branch, this is the comparison between the head of the default branch and the after commit. Otherwise, this shows all commits until the after commit. | |
| created | boolean | Whether this push created the ref. | |
| deleted | boolean | Whether this push deleted the ref. | |
| forced | boolean | Whether this push was a force push of the ref. | |
| headCommit | PushCommit | For pushes where after is or points to a commit object, an expanded representation of that commit. For pushes where after refers to an annotated tag object, an expanded representation of the commit pointed to by the annotated tag. | |
| pusher | { name: string; email: string; } | The user who pushed the commits. | |
| ref | string | The full git ref that was pushed. Example: refs/heads/main or refs/tags/v3.14.1. |