Skip to main content
PATCH
/
v1
/
notifications
/
webhooks
/
{webhook_id}
Update webhook
curl --request PATCH \
  --url https://api-m.sandbox.paypal.com/v1/notifications/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "op": "add",
    "path": "<string>",
    "value": "<any>",
    "from": "<string>"
  }
]'
{
  "id": "<string>",
  "url": "<string>",
  "event_types": [
    {
      "name": "<string>",
      "description": "<string>",
      "status": "<string>",
      "resource_versions": [
        "<string>"
      ]
    }
  ],
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Path Parameters

​
webhook_id
string
required

The ID of the webhook for which to list subscriptions.

Body

application/json · Patch · object[]

An array of JSON patch objects to apply partial updates to resources.

​
op
enum<string>
required

The operation.

Available options:
add,
remove,
replace,
move,
copy,
test
​
path
string

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location at which to complete the operation.

​
value
any

The value to apply. The <code>remove</code> operation does not require a value.

​
from
string

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location from which to move the value. Required for the <code>move</code> operation.

Response

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

One or more webhook objects.

​
url
string<uri>
required

The URL that is configured to listen on localhost for incoming POST notification messages that contain event information.

Maximum length: 2048
​
event_types
Event Type · object[]
required

An array of events to which to subscribe your webhook. To subscribe to all events, including events as they are added, specify the asterisk wild card. To replace the event_types array, specify the asterisk wild card. To list all supported events, <a href="#event-type_list">list available events</a>.

Maximum length: 500
​
id
string

The ID of the webhook.

​
links
Link Description · object[]

An array of request-related HATEOAS links.

⌘I