github.updaterepositorywebhookprops
Home > @runlightyear/github > UpdateRepositoryWebhookProps
UpdateRepositoryWebhookProps interface
Signature:interface UpdateRepositoryWebhookProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| hookId | number | The unique identifier of the hook. | |
| owner | string | The account owner of the repository. The name is not case sensitive. | |
| repo | string | The name of the repository. The name is not case sensitive. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| active? | boolean | Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. Default: true | |
| addEvents? | Array<string> | Determines a list of events to be added to the list of events that the Hook triggers for. | |
| config? | WebhookConfig | Key/value pairs to provide settings for this webhook. | |
| events? | Array<string> | Determines what events the hook is triggered for. This replaces the entire array of events. Default: push | |
| removeEvents? | Array<string> | Determines a list of events to be removed from the list of events that the Hook triggers for. |