github.pullrequestpayload
Home > @runlightyear/github > PullRequestPayload
PullRequestPayload interface
Documentation: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads\#pull\_request
Signature:interface PullRequestPayload extends CommonPayload
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| action | "assigned" | "auto_merge_disabled" | "auto_merge_enabled" /** * If the action is closed and the merged key is false, the pull request was closed with unmerged commits. If the action is closed and the merged key is true, the pull request was merged. */ | "closed" | "converted_to_draft" | "edited" | "labeled" | "locked" | "opened" | "ready_for_review" | "reopened" | "review_request_removed" | "review_requested" /** * Triggered when a pull request's head branch is updated. For example, when the head branch is updated from the base branch, when new commits are pushed to the head branch, or when the base branch is changed." */ | "synchronize" | "unassigned" | "unlabeled" | "unlocked" | The action that was performed. | |
| changes | { title: { from: string; }; body: { from: string; }; } | The changes to the comment if the action was edited. | |
| number | number | The pull request number. | |
| pullRequest | object | The pull request itself. |