POST /v1/notifications/simulate-event
Simulates a webhook event. In the JSON request body, specify a sample payload.
You need to subscribe to the following webhook events for Pay upon Invoice:
| Event | Trigger |
|---|---|
PAYMENT.CAPTURE.COMPLETED | A payment capture completes. |
PAYMENT.CAPTURE.DENIED | A payment capture is denied. |
CHECKOUT.PAYMENT-APPROVAL.REVERSED | PayPal reverses a payment capture. |
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 |
|---|---|---|---|
url |
String | No |
The URL for the webhook endpoint. If omitted, the webhook ID is required. |
resource_version |
String | No |
The identifier for event type ex: 1.0/2.0 etc. |
event_type |
String | Yes |
The event name. Specify one of the subscribed events. For each request, provide only one event. |
webhook_id |
String | No |
The ID of the webhook. If omitted, the URL is required. |
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.