On this page
No Headings
A list of webhooks events.
objecteventsarrayAn array of webhooks events.
itemsobjectA webhook event notification.
idstringThe ID of the webhook event notification.
create_timestringdate-timeThe date and time when the webhook event notification was created, in Internet date and time format.
resource_typestringThe name of the resource related to the webhook notification event.
event_versionstring^([0-9]+.[0-9]+)$The event version in the webhook notification.
event_typestringThe event that triggered the webhook event notification.
summarystringA summary description for the event notification.
resource_versionstring^([0-9]+.[0-9]+)$The resource version in the webhook notification.
resourceobjectThe resource that triggered the webhook event notification.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
countintegerThe number of items in each range of results. Note that the response might have fewer items than the requested page_size value.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstringThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstringThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.