Skip to main content
WEBHOOK
webhookTest
{
  "type": "webhook.test",
  "sentAt": "2025-04-11T08:15:00.000Z",
  "data": {
    "message": "This is a test delivery from UGiftMe. Your endpoint should return HTTP 2xx within 10 seconds.",
    "exampleOrderId": "ord_example_123"
  }
}

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.

​
X-Webhook-Delivery
enum<string>

Present with value test on manual test deliveries only.

Available options:
test

Body

application/json
​
type
string
required
Example:

"webhook.test"

​
sentAt
string<date-time>
required
​
data
object
required

Response

200

Your endpoint acknowledged the test (any 2xx)