List webhooks

Lists webhooks for an app.

GET /v1/notifications/webhooks

List webhooks

cURL

curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/notifications/webhooks \
  --header 'Authorization: Bearer <token>'

200

{
  "webhooks": [
    {
      "url": "<string>",
      "event_types": [
        {
          "name": "<string>",
          "description": "<string>",
          "status": "<string>",
          "resource_versions": [
            "<string>"
          ]
        }
      ],
      "id": "<string>",
      "links": [
        {
          "href": "<string>",
          "rel": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Query Parameters

anchor_type · enum<string> · default: APPLICATION

Filters the webhooks in the response by an anchor_id entity type.

Available options: APPLICATION, ACCOUNT

Response

200

application/json

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

A list of webhooks.

webhooks · Webhook · object[]

An array of webhooks.

Show child attributes