Share via


WebhookPropertiesUpdateParameters interface

The parameters for updating the properties of a webhook.

Properties

actions

The list of actions that trigger the webhook to post notifications.

customHeaders

Custom headers that will be added to the webhook notifications.

scope

The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.

serviceUri

The service URI for the webhook to post notifications.

status

The status of the webhook at the time the operation was called.

Property Details

actions

The list of actions that trigger the webhook to post notifications.

actions?: string[]

Property Value

string[]

customHeaders

Custom headers that will be added to the webhook notifications.

customHeaders?: Record<string, string>

Property Value

Record<string, string>

scope

The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.

scope?: string

Property Value

string

serviceUri

The service URI for the webhook to post notifications.

serviceUri?: string

Property Value

string

status

The status of the webhook at the time the operation was called.

status?: string

Property Value

string