github.commonpayload

Home > @runlightyear/github > CommonPayload

CommonPayload interface

Documentation: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads\#webhook-payload-object-common-properties

Signature:

interface CommonPayload 

Required Properties

Property	Modifiers	Type	Description
repository		Repository	The repository where the event occurred.
sender		User	The user that triggered the event.

Optional Properties

Property	Modifiers	Type	Description
enterprise?		object	An enterprise on GitHub.
installation?		object	The GitHub App installation.
organization?		object	Webhook payloads contain the organization object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.