Create a webhook

Useepay API V2.0 Sandbox Environment

https://openapi1.uat.useepay.com

POST

/api/v1/webhooks/create

Before using the webhook, ensure that the RSA key is enabled.
The IP address of the webhook notification domain needs to be provided to Useepay for whitelisting.

UseePay matches the sending addresses of webhooks through "x-merchant no" and "x-app id".
If you have multiple websites, you need to create webhooks for each website

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://openapi1.uat.useepay.com/api/v1/webhooks/create' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://demo.youshop.com/webhook",
    "api_version": "2024-11-21",
    "events": [
        "payment_intent.created",
        "payment_intent.requires_payment_method"
    ],
    "metadata": {
        "testkey": "111"
    },
    "status": "enabled"
}'

Response Example

{
    "id": "wek_1JHHVQLK40S00",
    "url": "https://demo.youshop.com/webhook",
    "description": null,
    "events": [
        "payment_intent.created",
        "payment_intent.requires_payment_method"
    ],
    "metadata": {
        "testkey": "111"
    },
    "status": null,
    "secret": null,
    "merchant_no": "500000000007264",
    "app_id": "www.pay.com",
    "create_at": "2024-11-15T01:59:52Z",
    "modify_at": "2024-11-15T01:59:52Z",
    "api_version": "2024-11-21"
}

Modified at 2026-05-07 08:20:27

Webhook events for example

Retrieves a webhook