Update a specific webhook in a repository.

patch

https://api.cloudsmith.io/webhooks/{owner}/{repo}/{identifier}/

Path Params

owner

string

required

repo

string

required

identifier

string

required

Body Params

events

array of strings | null

events

is_active

boolean

If enabled, the webhook will trigger on subscribed events and send payloads to the configured target URL.

package_query

string | null

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.

request_body_format

integer

enum

The format of the payloads for webhook requests. Valid options are: (0) JSON, (1) JSON array, (2) form encoded JSON and (3) Handlebars template.

Allowed:

request_body_template_format

integer

enum

The format of the payloads for webhook requests. Valid options are: (0) Generic/user defined, (1) JSON and (2) XML.

Allowed:

request_content_type

string | null

The value that will be sent for the 'Content Type' header.

secret_header

string | null

^[-\w]+$

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.

secret_value

string | null

^[^\n\r]+$

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.

signature_key

string

length between 1 and 512

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).

target_url

uri

length between 1 and 2000

The destination URL that webhook payloads will be POST'ed to.

templates

array of objects | null

templates

verify_ssl

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.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated the specified webhook

400Request could not be processed (see detail).

404Owner namespace or repository not found

422Missing or invalid parameters (see detail).

Cloudsmith is the new standard in Package / Artifact Management and Software Distribution