Skip to content

Latest commit

 

History

History
54 lines (47 loc) · 3.53 KB

File metadata and controls

54 lines (47 loc) · 3.53 KB

RepositoryWebhook

Properties

Name Type Description Notes
createdAt OffsetDateTime [optional]
createdBy String [optional]
createdByUrl String [optional]
disableReason java.math.BigInteger [optional]
disableReasonStr String [optional]
events List<EventsEnum>
identifier java.math.BigInteger Deprecated (23-05-15): Please use 'slug_perm' instead. Previously: A monotonically increasing number that identified a webhook request within a repository. [optional]
isActive Boolean If enabled, the webhook will trigger on subscribed events and send payloads to the configured target URL. [optional]
isLastResponseBad Boolean [optional]
lastResponseStatus java.math.BigInteger [optional]
lastResponseStatusStr String [optional]
numSent java.math.BigInteger [optional]
packageQuery String The package-based search query for webhooks to fire. This uses the same syntax as the standard search used for repositories, and also supports boolean logic operators such as OR/AND/NOT and parentheses for grouping. If a package does not match, the webhook will not fire. [optional]
requestBodyFormat java.math.BigInteger The format of the payloads for webhook requests. Valid options are: (0) JSON, (1) JSON array, (2) form encoded JSON and (3) Handlebars template. [optional]
requestBodyFormatStr String [optional]
requestBodyTemplateFormat java.math.BigInteger The format of the payloads for webhook requests. Valid options are: (0) Generic/user defined, (1) JSON and (2) XML. [optional]
requestBodyTemplateFormatStr String [optional]
requestContentType String The value that will be sent for the 'Content Type' header. [optional]
secretHeader String The header to send the predefined secret in. This must be unique from existing headers or it won't be sent. You can use this as a form of authentication on the endpoint side. [optional]
selfUrl String [optional]
slugPerm String [optional]
targetUrl String The destination URL that webhook payloads will be POST'ed to.
templates List<WebhookTemplate>
updatedAt OffsetDateTime [optional]
updatedBy String [optional]
updatedByUrl String [optional]
verifySsl Boolean If enabled, SSL certificates is verified when webhooks are sent. It's recommended to leave this enabled as not verifying the integrity of SSL certificates leaves you susceptible to Man-in-the-Middle (MITM) attacks. [optional]

Enum: List<EventsEnum>

Name Value
STAR "*"
PACKAGE_CREATED "package.created"
PACKAGE_DELETED "package.deleted"
PACKAGE_DOWNLOADED "package.downloaded"
PACKAGE_FAILED "package.failed"
PACKAGE_QUARANTINED "package.quarantined"
PACKAGE_RELEASED "package.released"
PACKAGE_RESTORED "package.restored"
PACKAGE_SECURITY_SCANNED "package.security_scanned"
PACKAGE_SYNCED "package.synced"
PACKAGE_SYNCING "package.syncing"
PACKAGE_TAGS_UPDATED "package.tags_updated"