API Reference

Configure or update webhook

post

Set the webhook endpoint for transaction notifications

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for authentication.

Body

application/json

urlstring · uriRequired

Webhook endpoint URL

secretstring · min: 6Required

Secret key for signature verification

Responses

200

Webhook set successfully

application/json

messagestringOptional

post

/webhooks

HTTPcURLJavaScriptPython

POST /api/webhooks HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "url": "https://your-server.com/api/kirapay-webhook",
  "secret": "your_webhook_secret_key"
}

200

Webhook set successfully

{
  "message": "text",
  "webhook": {
    "_id": "text",
    "url": "https://example.com",
    "createdAt": "2026-02-26T03:58:20.380Z"
  }
}