Deprecated (23-05-15): Please use 'slug_perm' instead. Previously: A monotonically increasing number that identified a webhook request within a repository.
is_active
boolean
optional
If enabled, the webhook will trigger on subscribed events and send payloads to the configured target URL.
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
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
optional
Allowed values: 0, 1, 2, 3
The format of the payloads for webhook requests. Valid options are: (0) JSON, (1) JSON array, (2) form encoded JSON and (3) Handlebars template.
request_body_format_str
string
optional
length ≥ 1
request_body_template_format
integer
optional
Allowed values: 0, 1, 2
The format of the payloads for webhook requests. Valid options are: (0) Generic/user defined, (1) JSON and (2) XML.
request_body_template_format_str
string
optional
length ≥ 1
request_content_type
string | null
optional
length ≤ 128
The value that will be sent for the 'Content Type' header.
secret_header
string | null
optional
^[-\w]+$ length ≤ 64
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.
self_url
uri
optional
slug_perm
slug
optional
^[-a-zA-Z0-9_]+$ length ≥ 1
target_url
uri
required
length between 1 and 2000
The destination URL that webhook payloads will be POST'ed to.
templates
array of objects | null
required
array of objects
object
event
string
required
length between 1 and 128
template
string | null
optional
length ≤ 4096
updated_at
date-time
optional
updated_by
string
optional
length ≥ 1
updated_by_url
uri
optional
verify_ssl
boolean
optional
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.
Request could not be processed (see detail).
object
object
detail
string
required
length ≥ 1
An extended message for the response.
fields
object
optional
A Dictionary of related errors where key: Field and value: Array of Errors related to that field
object
Missing or invalid parameters (see detail).
object
object
detail
string
required
length ≥ 1
An extended message for the response.
fields
object
optional
A Dictionary of related errors where key: Field and value: Array of Errors related to that field
