Skip to main content

github.createrepositorywebhookprops

Home > @runlightyear/github > CreateRepositoryWebhookProps

CreateRepositoryWebhookProps interface

Signature:
interface CreateRepositoryWebhookProps 

Required Properties

PropertyModifiersTypeDescription
ownerstringThe account owner of the repository. The name is not case sensitive.
repostringThe name of the repository. The name is not case sensitive.

Optional Properties

PropertyModifiersTypeDescription
active?booleanDetermines if notifications are sent when the webhook is triggered. Set to true to send notifications. Default: true
config?WebhookConfigKey/value pairs to provide settings for this webhook.
events?Array<WebhookEvent>Determines what events the hook is triggered for. Default: push
name?"web"Use web to create a webhook. Default: web. This parameter only accepts the value web.