Share via

WebhookProperties Class

The properties of a webhook.

Constructor

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

Variables

Name Description
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.
provisioning_state
str or ProvisioningState

The provisioning state of the webhook at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled".

Attributes

actions

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

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

provisioning_state

The provisioning state of the webhook at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled".

provisioning_state: str | _models.ProvisioningState | 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

status

"enabled" and "disabled".

status: str | _models.WebhookStatus | None