Skip to main content

Simulate webhook event

POST 
/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:

EventTrigger
PAYMENT.CAPTURE.COMPLETEDA payment capture completes.
PAYMENT.CAPTURE.DENIEDA payment capture is denied.
CHECKOUT.PAYMENT-APPROVAL.REVERSEDPayPal reverses a payment capture.

Request​

Body

    webhook_id string

    The ID of the webhook. If omitted, the URL is required.

    Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$

    url uri

    The URL for the webhook endpoint. If omitted, the webhook ID is required.

    Possible values: <= 2048 characters

    event_type stringrequired

    The event name. Specify one of the subscribed events. For each request, provide only one event.

    Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9.]+$

    resource_version string

    The identifier for event type ex: 1.0/2.0 etc.

Responses​

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

Schema
    id string

    The ID of the webhook event notification.

    create_time date-time

    The date and time when the webhook event notification was created, in Internet date and time format.

    resource_type string

    The name of the resource related to the webhook notification event.

    event_versionEvent Version (string)

    The event version in the webhook notification.

    Possible values: Value must match regular expression ^([0-9]+.[0-9]+)$

    object
    event_type string

    The event that triggered the webhook event notification.

    summary string

    A summary description for the event notification.

    resource_version

    Resource Version (string)

    The resource version in the webhook notification.

    Possible values: Value must match regular expression ^([0-9]+.[0-9]+)$

    object
    resourceobject

    The resource that triggered the webhook event notification.

    property name* any

    The resource that triggered the webhook event notification.

    links object[]

    An array of request-related HATEOAS links.

Loading...