Update webhook
PATCH {{base_url}}/v1/notifications/webhooks/:webhook_id
Updates a webhook to replace webhook fields with new values. Supports only the
replace
operation. Pass a
json_patch
object with
replace
operation and
path
, which is
/url
for a URL or
/event_types
for events. The
value
is either the URL or a list of events.
Request Body
{"0"=>{"op"=>"replace", "path"=>"/event_types", "value"=>[{"name"=>"CUSTOMER.DISPUTE.CREATED"}, {"name"=>"CATALOG.PRODUCT.CREATED"}, {"name"=>"BILLING.PLAN.PRICING-CHANGE.ACTIVATED"}, {"name"=>"PAYMENT.PAYOUTSBATCH.SUCCESS"}, {"name"=>"BILLING.PLAN.CREATED"}]}}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. |
| PayPal-Request-Id | string | | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. |
| PayPal-Client-Metadata-Id | string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. |
| PayPal-Partner-Attribution-Id | string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. |
| PayPal-Auth-Assertion | string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant.
|
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
| Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: OK
{"id":"58J42045AF4813205","url":"https://example.com/example_webhook_2","event_types":[{"name":"PAYMENT.SALE.REFUNDED","description":"A merchant refunds a sale."}],"links":[{"href":"https://api.sandbox.paypal.com/v1/notifications/webhooks/58J42045AF4813205","rel":"self","method":"GET"},{"href":"https://api.sandbox.paypal.com/v1/notifications/webhooks/58J42045AF4813205","rel":"update","method":"PATCH"},{"href":"https://api.sandbox.paypal.com/v1/notifications/webhooks/58J42045AF4813205","rel":"delete","method":"DELETE"}]}