Create webhook lookup

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

{
  "id": "<string>",
  "client_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Create webhook lookup

Creates a webhook lookup. A webhook lookup ties the API caller’s REST API app to the subject account (or, if no subject is specified, to the API caller’s account). If a webhook event is generated for an event that is tied to the account but not to a particular REST API app (for example, payments initiated with the NVP/SOAP APIs or through the user interface on PayPal.com), those webhook events will treated as if they were intended for the REST API app registered in the webhook lookup instead. Webhook events will then be delivered to any webhooks registered to that REST API app.

POST

notifications

webhooks-lookup

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

{
  "id": "<string>",
  "client_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

Authorization

string

header

required

Oauth 2.0 authentication

Response

A successful request returns the HTTP 201 Created status code and a JSON response body that shows webhook lookup details.

The webhook lookup details.

string

The ID of the webhook lookup.

client_id

string

The application client ID.

Maximum string length: 128

links

Link Description · object[]

An array of request-related HATEOAS links.

Show child attributes

List webhook lookups

Show webhook lookup details

⌘I

Orders v2

Payments v2

Payment Method Tokens v3

Invoicing v2

Currency Exchange v2

Transaction Search v1

Payouts v1

Webhooks Management v1

Customer Disputes v1

Payment Links and Buttons v1

Create webhook lookup

Authorizations

Response