Skip to main content
POST
/
api
/
v1
/
business
/
webhooks
/
test
Send test delivery
curl --request POST \
  --url https://api-stage.ugift.me/api/v1/business/webhooks/test \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "webhookId": "65d3f4a5b6c7d89012345678"
}
'
{
  "ok": true,
  "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"
    }
  },
  "statusCode": 200,
  "errorMessage": "<string>"
}

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>

Body

application/json
​
webhookId
string
required

Id of a webhook subscription you own

Example:

"65d3f4a5b6c7d89012345678"

Response

Test delivery attempt result

​
ok
boolean
required

Whether your endpoint returned HTTP 2xx

​
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"
  }
}
​
statusCode
integer

HTTP status from your endpoint, if a response was received

Example:

200

​
errorMessage
string

Present when ok is false