On this page
No Headings
One or more webhook objects.
objectidstringThe ID of the webhook.
urlrequiredstringuriThe URL that is configured to listen on localhost for incoming POST notification messages that contain event information.
event_typesrequiredarrayAn array of events to which to subscribe your webhook. To subscribe to all events, including events as they are added, specify the asterisk wild card. To replace the event_types array, specify the asterisk wild card. To list all supported events, list available events.
itemsobjectAn event type.
namerequiredstringThe unique event name.
Note: To subscribe to all events, including events as they are added, specify an * as the value to represent a wildcard.descriptionstringA human-readable description of the event.
statusstringThe status of a webhook event.
resource_versionsarrayIdentifier for the event type example: 1.0/2.0 etc.
itemsstringThe ID for an event type. For example, 1.0 or 2.0.
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.