List webhooks

GET 
/webhooks

Lists webhooks for an app.

Request

Query Parameters

anchor_type string
Possible values: [APPLICATION, ACCOUNT]
Filters the webhooks in the response by an anchor_id entity type.
Default value: APPLICATION

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that lists webhooks with webhook details.

application/json

Schema

Schema

webhooks object[]

An array of webhooks.

Example (from schema)

{
  "webhooks": [
    {
      "id": "string",
      "url": "string",
      "event_types": [
        {
          "name": "string",
          "description": "string",
          "status": "string",
          "resource_versions": [
            "string"
          ]
        }
      ],
      "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...