Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 2.46 KB

File metadata and controls

21 lines (17 loc) · 2.46 KB

RepositoryWebhookRequest

Properties

Name Type Description Notes
events list[str]
is_active bool If enabled, the webhook will trigger on subscribed events and send payloads to the configured target URL. [optional]
package_query str 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]
request_body_format int 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]
request_body_template_format int The format of the payloads for webhook requests. Valid options are: (0) Generic/user defined, (1) JSON and (2) XML. [optional]
request_content_type str The value that will be sent for the 'Content Type' header. [optional]
secret_header str 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]
secret_value str The value for the predefined secret (note: this is treated as a passphrase and is encrypted when we store it). You can use this as a form of authentication on the endpoint side. [optional]
signature_key str The value for the signature key - This is used to generate an HMAC-based hex digest of the request body, which we send as the X-Cloudsmith-Signature header so that you can ensure that the request wasn't modified by a malicious party (note: this is treated as a passphrase and is encrypted when we store it). [optional]
target_url str The destination URL that webhook payloads will be POST'ed to.
templates list[WebhookTemplate]
verify_ssl bool 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]

[Back to Model list] [Back to API list] [Back to README]