Skip to main content
WEBHOOK

Authorizations

X-API-Key
string
header
required

Your UGiftMe API key for authentication.

Format: Secure API key (e.g., <your-api-key>)

Required: All endpoints require this header

Example: X-API-Key: <your-api-key>

Headers

X-Webhook-Event
string
required

Event name (matches the subscribed event or webhook.test for test deliveries).

X-Webhook-Signature
string
required

HMAC-SHA256 hex digest of the JSON body, using your webhook secret.

Body

application/json
userId
string
required
currency
string
required
balance
number
required
availableBalance
number
required
source
string
required
Example:

"api_order_async"

timestamp
string<date-time>
required
transaction
object

Response

200

Your endpoint acknowledged the delivery (any 2xx)