Register Webhook

POST

/webhooks/register

Required API Key in header: X-API-Key

Available events:

order.created

order.updated (when quantity is updated for 'new' orders)

order.completed (when status changes to 'done')

(all events)

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Successful Response

Body

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/webhooks/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "events": [
        "order.created",
        "order.updated",
        "payment.*"
    ],
    "url": "https://example.com/webhook"
}'

Response Example

200 - Example 1

{
    "property1": "string",
    "property2": "string"
}

Modified at 2025-09-15 17:52:50

Delete Order

Update Webhook