List event notifications

GET 
/webhooks-events

Lists webhooks event notifications. Use query parameters to filter the response.

Request

Query Parameters

page_size integer
The number of webhook event notifications to return in the response.
Default value: 10
start_time string

Filters the webhook event notifications in the response to those created on or after this date and time and on or before the end_time value. Both values are in Internet date and time format format. Example: start_time=2013-03-06T11:00:00Z.

end_time string

Filters the webhook event notifications in the response to those created on or after the start_time and on or before this date and time. Both values are in Internet date and time format format. Example: end_time=2013-03-06T11:00:00Z.

transaction_id string

Filters the response to a single transaction, by ID.

event_type string

Filters the response to a single event.

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that lists webhooks event notifications.

application/json

Schema

Schema

events object[]

An array of webhooks events.

count integer

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

links object[]

An array of request-related HATEOAS links.

Example (from schema)

{
  "events": [
    {
      "id": "string",
      "create_time": "2024-07-29T15:51:28.071Z",
      "resource_type": "string",
      "event_version": "string",
      "event_type": "string",
      "summary": "string",
      "resource_version": "string",
      "resource": {},
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ]
    }
  ],
  "count": 0,
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

default

The error response.

application/json

Schema

Schema

name stringrequired

The human-readable, unique name of the error.

message stringrequired

The message that describes the error.

debug_id stringrequired

The PayPal internal ID. Used for correlation purposes.

information_link string

The information link, or URI, that shows detailed information about this error for the developer.

details object[]

An array of additional details about the error.

links object[]

An array of request-related HATEOAS links.

Example (from schema)

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

Loading...