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:
Property NameSupported Operators
categoryEquals (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 NameDescription
nameName of the webhook.
categoryCategory of the webhook.
enabledEnabled flag or the webhook.

Format orderBy={PropertyName}:{asc:desc}
Example orderBy=name:desc

Request

Query Parameters
  • A positive integer value specifies the maximum number of items returned in the response.
    Default Value: 100
  • 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
  • Comma-separated string of field names, each optionally followed by `:asc` or `:desc`, that specifies the order of items returned in the response.
  • Filtering of the resources.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Webhook Collection
Type: object
Webhook Collection
Show Source
  • Total number of resources in the response.
    Example: 10
  • 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
    Singular resources contained in the collection.
  • 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
  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.
    Example: 0
  • 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
Nested Schema : Webhook
Type: object
Webhook Configuration Data
Show Source
Nested Schema : User
Type: object
User Metadata Model.
Show Source
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
Nested Schema : Payload
Type: object
Payload configuration for the Webhook. Supported pay load names are:
empty
brief
detailed
Show Source
  • Name for the payload. Brief is the default value for webhook is payload is not set
    Example: brief
Nested Schema : Target
Type: object
Target end point details for the Webhook.
Show Source
Nested Schema : Webhook Events
Type: object
Event details for Webhook.
Show Source
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: object
Show Source
Nested Schema : objectIds
Type: array
List of ids of the objectType.
Show Source
Example:
{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}
Nested Schema : Security
Type: object
Security configuration for the Webhook target end point.
Show Source
Nested Schema : BasicAuth
Type: object
Basic authentication configuration details. The details will be sent in Authorization header
Show Source
Nested Schema : Headers
Type: object
Header based authorization configuration details.
Show Source
Nested Schema : SignatureSecurity
Type: object
Signature based security configuration details.
Show Source
Nested Schema : headers
Type: array
List of headers.
Show Source
Nested Schema : Request Header
Type: object
Request Header
Show Source

304 Response

Not Modified
Body ()
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
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • 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
Body ()
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
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • 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
Body ()
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
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • 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
Body ()
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
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • 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.
Back to Top