POST /v1/notifications/webhooks
Subscribes your webhook listener to events.
Servers
- https://api-m.sandbox.paypal.com
- https://api-m.paypal.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
The ID of the webhook. |
url |
String | Yes |
The URL that is configured to listen on |
event_types[] |
Array | Yes |
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[].name |
String | Yes |
The unique event name. Note: To subscribe to all events, including events as they are added, specify an
|
event_types[].description |
String | No |
A human-readable description of the event. |
event_types[].resource_versions[] |
Array | No |
Identifier for the event type example: 1.0/2.0 etc. |
event_types[].status |
String | No |
The status of a webhook event. |
links[] |
Array | No |
An array of request-related HATEOAS links. |
links[].href |
String | Yes |
The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the |
links[].method |
String | No |
The HTTP method required to make the related call. Possible values:
|
links[].rel |
String | Yes |
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.