Skip to main content
WEBHOOK
orderFailed
{
  "orderRequestId": "65e4f5b6c7d8e90123456789",
  "status": "failed",
  "error": "Insufficient available balance. Required: 50, Available: 10 GBP",
  "timestamp": "2025-04-11T08:01:00.000Z"
}

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
​
orderRequestId
string
required
​
status
enum<string>
required
Available options:
failed
​
error
string
required
​
timestamp
string<date-time>
required

Response

200

Your endpoint acknowledged the delivery (any 2xx)