Create webhook

Subscribes your webhook listener to events.

post/v1/notifications/webhooks

Request

Base URL
https://api-m.paypal.com
Auth
OAuth 2
Client credentials
Token URL/v1/oauth2/token
Scopeshttps://uri.paypal.com/services/applications/webhooks
TypeScript
https://skmtc.dev/paypal/apis/payments/docs/v1/notifications/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring

The ID of the webhook.

urlstring uri required

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

Response

A successful request returns the HTTP 201 Created status code and a JSON response body with a webhook object that includes the webhook ID for later use.