API Reference
Open Cloudsmith

Webhooks

Webhooks Partial Update

Update a specific webhook in a repository.

Request

patchhttps://api.cloudsmith.io/v1/webhooks/{owner}/{repo}/{identifier}
Body params optional

Response body

object

object

events
array of strings | null
optional
is_active
boolean
optional
package_query
string | null
optional
length ≤ 1024
request_body_format
integer
optional
Allowed values: 0, 1, 2, 3
request_body_template_format
integer
optional
Allowed values: 0, 1, 2
request_content_type
string | null
optional
length ≤ 128
secret_header
string | null
optional
^[-\w]+$
length ≤ 64
secret_value
string | null
optional
^[^\n\r]+$
length ≤ 512
signature_key
string
optional
length between 1 and 512
target_url
uri
optional
length between 1 and 255
templates
array of objects | null
optional
verify_ssl
boolean
optional

Response

Responses

Updated the specified webhook

object

object

created_at
date-time
optional
created_by
string
optional
length ≥ 1
created_by_url
uri
optional
disable_reason
integer
optional
Allowed values: 0, 1, 2, 3, 4, 5, 6
disable_reason_str
string
optional
length ≥ 1
events
array of strings | null
required
identifier
integer | null
optional
is_active
boolean
optional
is_last_response_bad
boolean
optional
last_response_status
integer
optional
last_response_status_str
string
optional
length ≥ 1
num_sent
integer
optional
package_query
string | null
optional
length ≤ 1024
request_body_format
integer
optional
Allowed values: 0, 1, 2, 3
request_body_format_str
string
optional
length ≥ 1
request_body_template_format
integer
optional
Allowed values: 0, 1, 2
request_body_template_format_str
string
optional
length ≥ 1
request_content_type
string | null
optional
length ≤ 128
secret_header
string | null
optional
^[-\w]+$
length ≤ 64
self_url
uri
optional
slug_perm
slug
optional
^[-a-zA-Z0-9_]+$
length ≥ 1
target_url
uri
required
length between 1 and 255
templates
array of objects | null
required
updated_at
date-time
optional
updated_by
string
optional
length ≥ 1
updated_by_url
uri
optional
verify_ssl
boolean
optional

Request could not be processed (see detail).

object

object

detail
string
required
length ≥ 1
fields
object
optional

Owner namespace or repository not found

object

object

detail
string
required
length ≥ 1
fields
object
optional

Missing or invalid parameters (see detail).

object

object

detail
string
required
length ≥ 1
fields
object
optional