/webhooks

Authorization

API-Key

token<token>

API key authentication via header (token)

In: header

Request Body

application/json

Webhook registration details

url*string

The webhook URL to receive notifications. Only public http and https destinations are allowed.

Formaturi

Lengthlength <= 500

authToken?|

Authentication token for extended webhook requests. Required when format is EXTENDED

Length10 <= length <= 200

format?string

Webhook delivery format. Defaults to EXTENDED

Default"EXTENDED"

Value in"EXTENDED" | "SLACK" | "GOOGLE_CHAT" | "DISCORD"

Events*array<>

Array of event types to subscribe to

Items1 <= items <= 10

name?string

Human-readable name for the webhook

Lengthlength <= 100

paymentSourceId?|

Optional: link webhook to specific payment source

Response Body

`application/json`

curl -X POST "https://loading/./../api/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "https://your-server.com/webhook",    "authToken": "your-webhook-secret-token",    "Events": [      "PURCHASE_ON_CHAIN_STATUS_CHANGED",      "WALLET_LOW_BALANCE"    ],    "name": "My Payment Webhook",    "paymentSourceId": "payment_source_id_optional"  }'

{
  "status": "Success",
  "data": {
    "id": "webhook_endpoint_id",
    "url": "https://your-server.com/webhook",
    "name": "My Payment Webhook",
    "Events": [
      "PURCHASE_ON_CHAIN_STATUS_CHANGED",
      "WALLET_LOW_BALANCE"
    ],
    "isActive": true,
    "createdAt": "1970-01-20T20:00:36.260Z",
    "paymentSourceId": null
  }
}

Empty

/webhooks

Authorization

Request Body

Response Body

200application/json

400

401

404

409

500

`application/json`