Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Event List

A list of webhooks events.

eventsobject<event>[]Optional

An array of webhooks events.

event properties

9 properties

idstringOptional

The ID of the webhook event notification.

create_timestringOptional

The date and time when the webhook event notification was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Formatdate-time

resource_typestringOptional

The name of the resource related to the webhook notification event.

event_versionstring<event_version>OptionalDeprecated

The event version in the webhook notification.

Match^([0-9]+.[0-9]+)$

event_typestringOptional

The event that triggered the webhook event notification.

summarystringOptional

A summary description for the event notification.

resource_versionstring<resource_version>Optional

The resource version in the webhook notification.

Match^([0-9]+.[0-9]+)$

resourceobject<resource>Optional

The resource that triggered the webhook event notification.

linksobject<link_description>[]Optional

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.

countintegerOptional

The number of items in each range of results. Note that the response might have fewer items than the requested `page_size` value.

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

link_description properties

3 properties

hrefstringRequired

relstringRequired

methodenumOptional

The HTTP method required to make the related call.

Back to top

Event List

A list of webhooks events.

eventsobject<event>[]Optional

An array of webhooks events.

event properties

9 properties

idstringOptional

The ID of the webhook event notification.

create_timestringOptional

The date and time when the webhook event notification was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Formatdate-time

resource_typestringOptional

The name of the resource related to the webhook notification event.

event_versionstring<event_version>OptionalDeprecated

The event version in the webhook notification.

Match^([0-9]+.[0-9]+)$

event_typestringOptional

The event that triggered the webhook event notification.

summarystringOptional

A summary description for the event notification.

resource_versionstring<resource_version>Optional

The resource version in the webhook notification.

Match^([0-9]+.[0-9]+)$

resourceobject<resource>Optional

The resource that triggered the webhook event notification.

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

link_description properties

3 properties

hrefstringRequired

relstringRequired

methodenumOptional

The HTTP method required to make the related call.

countintegerOptional

The number of items in each range of results. Note that the response might have fewer items than the requested `page_size` value.

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

link_description properties

3 properties

hrefstringRequired

relstringRequired

methodenumOptional

The HTTP method required to make the related call.

Event List

event properties

link_description properties

link_description properties

Back to top

On this page

On this page

Event List

event properties

link_description properties

link_description properties

Back to top

On this page

Event List

event properties

link_description properties

link_description properties

Back to top

On this page

On this page

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

Event List

event properties

link_description properties

link_description properties

Back to top

On this page