Skip to content

Interface: GithubWebhookEvent ​

Defined in: github/src/executors/github-webhook-event.ts:47

Default typed GitHub webhook delivery event payload emitted by github.webhookStream(...).

Supports structured access to action, repository.full_name, and pull_request properties while allowing additional webhook fields via index signature.

Indexable ​

ts
[key: string]: unknown

Additional arbitrary webhook event properties.

Properties ​

PropertyModifierTypeDescriptionDefined in
action?readonlystringOptional webhook action subtype (such as 'closed' or 'opened').github/src/executors/github-webhook-event.ts:49
pull_requestreadonlyGithubWebhookPullRequestPayloadPull request descriptor for pull_request webhook deliveries.github/src/executors/github-webhook-event.ts:53
repository?readonlyGithubWebhookRepositoryPayloadOptional repository metadata descriptor.github/src/executors/github-webhook-event.ts:51

Released under the MIT License.