List Webhook Logs
get
/system/api/v1/webhooks/{id}/logs
Get all Webhook Logs . This will list all successful and failed calls to Webhook end point. The list can be filtered using query parameter.
## Filters
The following properties are filterable and can be used in the `q` parameter:
Example q=status eq pass ## 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 invokedAt=name:desc
| Property Name | Supported Operators | |
| eventid | Equals (eq) | |
| status | Equals (eq) . Supported values are pass, fail | |
| invokedAt | Greater than or equal to(ge) and Less than or equal to(le) |
Example q=status eq pass ## 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 | |
| invokedAt | Date and time at which the webhook was invoked. The supported date formats are - ISO 8601 Date-Time format (Eg: 2022-10-15T06:24:24.713Z) or ISO 8601 Date format (Eg: 2022-10-15) |
Format orderBy={PropertyName}:{asc:desc}
Example invokedAt=name:desc
Request
Path Parameters
-
id: integer(int64)
id of the Webhook.
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 logs Collection
Type:
objectWebhook logs 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:
arraySingular resources contained in the collection.
Show Source
-
Array of:
object Webhook logs
Webhook end point log data
Nested Schema : links
Type:
arrayLink 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 logs
Type:
objectWebhook end point log data
Show Source
-
eventId(optional):
string
Id of the event for which the webhook call is generated
-
id(optional):
integer(int64)
Unique id of the webhook log.Example:
2367 -
invokedAt(optional):
string
Date and time at which the webhook end point was invoked . Date and time values are in ISO 8601 format with UTC timezone.
-
request(optional):
string
Details about the request that system send to webhook end point.
-
response(optional):
string
Details about the response that is returned by the end point.
-
status(optional):
string
Status of the webhook call. Values can be pass or fail.
Nested Schema : Link
Type:
objectREST 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.
304 Response
Not Modified
Root Schema : ExceptionDetail
Type:
objectError 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:
arrayMultiple 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:
objectError 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:
arrayMultiple 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:
objectError 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:
arrayMultiple 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:
objectError 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:
arrayMultiple 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.