List available events

GET 
/webhooks-event-types

Lists available events to which any webhook can subscribe. For a list of supported events, see Webhook event names.

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that lists available events to which any webhook can subscribe.

application/json

Schema

Schema

event_types object[]

An array of webhook events.

Example (from schema)

{
  "event_types": [
    {
      "name": "string",
      "description": "string",
      "status": "string",
      "resource_versions": [
        "string"
      ]
    }
  ]
}

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...