github.createpayload
Home > @runlightyear/github > CreatePayload
CreatePayload interface
Documentation: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads\#create
Signature:interface CreatePayload extends CommonPayload
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| description | string | null | The repository's current description. | |
| masterBranch | string | The name of the repository's default branch (usually main). | |
| pusherType | string | The pusher type for the event. Can be either user or a deploy key. | |
| ref | string | The git ref resource. | |
| refType | "tag" | "branch" | The type of Git ref object created in the repository. Can be one of: tag, branch |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| enterprise? | object | An enterprise on GitHub. |