List Webhooks
get
/system/api/v1/webhooks
List all Webhooks that user has access to. List can be filtered using query parameter,
## Filters
The following properties are filterable and can be used in the `q` parameter:
Example q=category eq "ASSET_LIFECYCLE" ## Sorting The orderBy parameter is used to control the order (ascending/descending) of queried items. This parameter is optional in the query and by default there is no order of results. This parameter accepts a field name separated by a colon (:) ,for which the user wants to sort the results.
Format orderBy={PropertyName}:{asc:desc}
Example orderBy=name:desc
Property Name | Supported Operators | |
category | Equals (eq) |
Example q=category eq "ASSET_LIFECYCLE" ## Sorting The orderBy parameter is used to control the order (ascending/descending) of queried items. This parameter is optional in the query and by default there is no order of results. This parameter accepts a field name separated by a colon (:) ,for which the user wants to sort the results.
Property Name | Description | |
name | Name of the webhook. | |
category | Category of the webhook. | |
enabled | Enabled flag or the webhook. |
Format orderBy={PropertyName}:{asc:desc}
Example orderBy=name:desc
Request
Query Parameters
-
limit(optional): integer(int32)
A positive integer value specifies the maximum number of items returned in the response.Default Value:
100
-
offset(optional): integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at `0`. The default offset is `0`, which returns all items starting from the first item in the collection.Default Value:
0
-
orderBy(optional): string
Comma-separated string of field names, each optionally followed by `:asc` or `:desc`, that specifies the order of items returned in the response.
-
q(optional): string
Filtering of the resources.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Webhook Collection
Type:
object
Webhook Collection
Show Source
-
count(optional):
integer(int64)
Total number of resources in the response.Example:
10
-
hasMore(optional):
boolean
Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.Example:
true
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int64)
Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.Example:
10
-
links(optional):
array links
Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
offset(optional):
integer(int64)
Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.Example:
0
-
totalResults(optional):
integer(int64)
Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the `totalResults` parameter is supported and is set to `true` by the client.Example:
10
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object Webhook
Webhook Configuration Data
Nested Schema : links
Type:
array
Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
Show Source
-
Array of:
object Link
REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
Nested Schema : Webhook
Type:
object
Webhook Configuration Data
Show Source
-
category(optional):
string
Category of the webhook. List of supported categories are
ASSET_PUBLISHING
ASSET_LIFECYCLEExample:Asset Lifecycle
-
createdAt(optional):
string
Date and time at which the webhook was created. Date and time values are in ISO 8601 format with UTC timezone.
-
createdBy(optional):
object User
User Metadata Model.
-
description(optional):
string
Description of the V1WebhookRestInfo.Example:
foo description
-
enabled(optional):
boolean
Flag to turn on/off a webhook. If the webhook is not enabled, Target URL will not be invoked when the event happens
-
eventDetails(optional):
array eventDetails
Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required
-
id(optional):
integer(int64)
Unique id of the webhook.It is a required property to read, update and delete a webhook.Example:
2367
-
links(optional):
array links
Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
name(optional):
string
Name of the webhook.Example:
foo
-
payload(optional):
object Payload
Payload configuration for the Webhook. Supported pay load names are:
empty
brief
detailed -
target(optional):
object Target
Target end point details for the Webhook.
-
updatedAt(optional):
string
Date and time at which the webhook was updated. Date and time values are in ISO 8601 format with UTC timezone.
-
updatedBy(optional):
object User
User Metadata Model.
Nested Schema : User
Type:
object
User Metadata Model.
Show Source
-
displayName(optional):
string
The display name of the user.Example:
My Display Name
-
id(optional):
string
The id of the user.Example:
10002
-
name(optional):
string
The name of the user.Example:
example@myorg.com
Nested Schema : eventDetails
Type:
array
Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required
Show Source
-
Array of:
object Webhook Events
Event details for Webhook.
Nested Schema : links
Type:
array
Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
Show Source
-
Array of:
object Link
REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
Nested Schema : Payload
Type:
object
Payload configuration for the Webhook. Supported pay load names are:
empty
brief
detailed
Show Source
empty
brief
detailed
-
name(optional):
string
Name for the payload. Brief is the default value for webhook is payload is not setExample:
brief
Nested Schema : Target
Type:
object
Target end point details for the Webhook.
Show Source
-
security(optional):
object Security
Security configuration for the Webhook target end point.
-
url(optional):
string
URL of the webhook end pointExample:
http://www.myserver.com/foo
Nested Schema : Webhook Events
Type:
object
Event details for Webhook.
Show Source
-
eventNames(optional):
array eventNames
List of events. Event names can be retrieved from /events/types?expand=all end point
-
filter(optional):
object Filter
Nested Schema : eventNames
Type:
array
List of events. Event names can be retrieved from /events/types?expand=all end point
Show Source
Example:
contentitem_created,contentitem_published,digitalasset_created
Nested Schema : Filter
Type:
Show Source
object
-
objectIds(optional):
array objectIds
List of ids of the objectType.
-
objectType(optional):
string
Filter objectType name. It can be repository or channel.Example:
repository
Nested Schema : objectIds
Type:
array
List of ids of the objectType.
Show Source
Example:
{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}
Nested Schema : Link
Type:
object
REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
Show Source
-
href(optional):
string
The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`.
-
mediaType(optional):
string
Link target. Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
Link target HTTP method. HTTP method for requesting the target of the link. * `none` - Indicates no valid HTTP method * `OPTIONS` - HTTP OPTIONS * `HEAD` - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
-
profile(optional):
string
Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present.
Nested Schema : Security
Type:
object
Security configuration for the Webhook target end point.
Show Source
-
basicAuth(optional):
object BasicAuth
Basic authentication configuration details. The details will be sent in Authorization header
-
headerAuth(optional):
object Headers
Header based authorization configuration details.
-
signatureSecurity(optional):
object SignatureSecurity
Signature based security configuration details.
Nested Schema : BasicAuth
Type:
object
Basic authentication configuration details. The details will be sent in Authorization header
Show Source
-
password(optional):
string
password for basic authentication
-
realm(optional):
string
realm for basic authentication
-
username(optional):
string
username for basic authentication
Nested Schema : Headers
Type:
object
Header based authorization configuration details.
Show Source
-
headers(optional):
array headers
List of headers.
Nested Schema : SignatureSecurity
Type:
object
Signature based security configuration details.
Show Source
-
signatureToken(optional):
string
Signature Token should be lowercase alphanumeric [a-z, 0-9] string of length 32.
Nested Schema : headers
Type:
array
List of headers.
Show Source
-
Array of:
object Request Header
Request Header
Nested Schema : Request Header
Type:
object
Request Header
Show Source
-
key(optional):
string
Key of the header
-
value(optional):
string
Value of the header
304 Response
Not Modified
Root Schema : ExceptionDetail
Type:
object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object ExceptionDetail
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
400 Response
Bad Request
Root Schema : ExceptionDetail
Type:
object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object ExceptionDetail
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
404 Response
Not Found
Root Schema : ExceptionDetail
Type:
object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object ExceptionDetail
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
500 Response
Internal Server Error
Root Schema : ExceptionDetail
Type:
object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object ExceptionDetail
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.