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 /v1/notifications/webhooks-lookup

Create webhook lookup

cURL

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

201

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

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Response

201

application/json

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

The webhook lookup details.

id · string · read-only

The ID of the webhook lookup.

client_id · string · read-only

The application client ID.

Maximum string length: 128

Pattern: ^(?!\d+$)\w+\S+

links · Link Description · object[] · read-only

An array of request-related HATEOAS links.

Show child attributes