Skip to main content
GET
/
api
/
v1
/
business
/
webhooks
/
test-sample
Test delivery sample
curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/webhooks/test-sample \
  --header 'X-API-Key: <api-key>'
{
  "event": "webhook.test",
  "payload": {
    "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>

Response

Sample test event

​
event
string
required
Example:

"webhook.test"

​
payload
object
required
Example:
{
  "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"
  }
}