If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more
webhook_list
An array of webhooks.
An array of webhook objects.
idstringOptional
The ID of the webhook.
urlstringRequired
The URL that is configured to listen on `localhost` for incoming `POST` notification messages that contain event information.
An 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.
Items0 <= length <= 500
event_type properties
4 properties
namestringRequired
The unique event name.
Note: To subscribe to all events, including events as they are added, specify an `*` as the value to represent a wildcard.
An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).
link_description properties
3 properties
hrefstringRequired
The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.
relstringRequired
The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).
methodenumOptional
The HTTP method required to make the related call.