Package version:

Interface WebhookCreateParameters

The parameters for creating a webhook.

Hierarchy

  • WebhookCreateParameters

Properties

actions? customHeaders? location scope? serviceUri? status? tags?

Properties

Optional actions

actions?: string[]

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

Optional customHeaders

customHeaders?: {
    [propertyName: string]: string;
}

Custom headers that will be added to the webhook notifications.

Type declaration

  • [propertyName: string]: string

location

location: string

The location of the webhook. This cannot be changed after the resource is created.

Optional scope

scope?: string

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.

Optional serviceUri

serviceUri?: string

The service URI for the webhook to post notifications.

Optional status

status?: string

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

Optional tags

tags?: {
    [propertyName: string]: string;
}

The tags for the webhook.

Type declaration

  • [propertyName: string]: string

Settings

Member Visibility

Theme

Generated using TypeDoc