---
title: "Simulate webhook event"
method: POST
path: "/v1/notifications/simulate-event"
tags: ["simulate-event"]
---

# Simulate webhook event

`POST /v1/notifications/simulate-event`

Simulates a webhook event. In the JSON request body, specify a sample payload. <br/> You need to subscribe to the following webhook events for Pay upon Invoice:<br/><table><thead><tr><th>Event</th><th>Trigger</th></tr></thead><tbody><tr><td><code>PAYMENT.CAPTURE.COMPLETED</code></td><td>A payment capture completes.</td></tr><tr><td><code>PAYMENT.CAPTURE.DENIED</code></td><td>A payment capture is denied.</td></tr><tr><td><code>CHECKOUT.PAYMENT-APPROVAL.REVERSED</code></td><td>PayPal reverses a payment capture.</td></tr></tbody></table>

## Request body

- SimulateEvent — Simulates a mock webhook event.
  - `webhook_id` string — The ID of the webhook. If omitted, the URL is required.
  - `url` string, uri — The URL for the webhook endpoint. If omitted, the webhook ID is required.
  - `event_type` string, required — The event name. Specify one of the subscribed events. For each request, provide only one event.
  - `resource_version` string — The identifier for event type ex: 1.0/2.0 etc.

## Response `202`

A successful request returns the HTTP `202 Accepted` status code and a JSON response body that shows details for the mock event.

- Event — A webhook event notification.
  - `id` string — The ID of the webhook event notification.
  - `create_time` string, date-time — The date and time when the webhook event notification was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
  - `resource_type` string — The name of the resource related to the webhook notification event.
  - `event_version` string — The event version in the webhook notification.
  - `event_type` string — The event that triggered the webhook event notification.
  - `summary` string — A summary description for the event notification.
  - `resource_version` string — The resource version in the webhook notification.
  - `resource` Resource — The resource that triggered the webhook event notification.
  - `links` LinkDescription[] — An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
    - `href` string, required — The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.
    - `rel` string, required — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).
    - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'PATCH' — The HTTP method required to make the related call.

## Other responses

- `default` — The error response.

---

[API](https://skmtc.net/paypal/apis/payments.md) · [All operations](https://skmtc.net/paypal/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paypal/payments/revisions/672aceee1190/schema)