Share via

WebhookPropertiesCreateParameters Class

The parameters for creating the properties of a webhook.

Constructor

WebhookPropertiesCreateParameters(*args: Any, **kwargs: Any)

Variables

Name Description
service_uri
str

The service URI for the webhook to post notifications. Required.
custom_headers
dict[str, str]

Custom headers that will be added to the webhook notifications.
status
str or WebhookStatus

The status of the webhook at the time the operation was called. Known values are: "enabled" and "disabled".
scope
str

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.
actions
list[str or WebhookAction]

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

Attributes

actions

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

actions: list[typing.Union[str, ForwardRef('_models.WebhookAction')]]

custom_headers

Custom headers that will be added to the webhook notifications.

custom_headers: dict[str, str] | None

scope

*<<' 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: str | None

service_uri

The service URI for the webhook to post notifications. Required.

service_uri: str

status

"enabled" and "disabled".

status: str | _models.WebhookStatus | None